Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ibrahimraimi committed Apr 10, 2024
1 parent 130b468 commit fc61b27
Showing 1 changed file with 23 additions and 11 deletions.
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,49 @@

The QuickSail Stack is a versatile and efficient boilerplate for web application development, designed to help developers set sail quickly on their SAAS project.

<!-- ### Introduction
### Local Setup

Welcome to the QuickSail Stack documentation! This guide is crafted specifically for solo-entrepreneurs seeking to expedite the development and deployment of their SaaS products. With QuickSail Stack, you can focus on building your business logic while leveraging a powerful tech stack to handle the rest. -->
Clone the QuickSail repository from GitHub.

### Installation
```sh
git clone https://github.com/ibrahimraimi/quicksail
```
#### Install dependencies

- Clone the QuickSail repository from GitHub.
- Install dependencies using npm, pnpm or yarn.
> Make sure to give execute permissions to the script
```sh
git clone https://github.com/ibrahimraimi/quicksail
chmod +x ./scripts/install_dependencies.sh
```

> Then you can run the script:
cd quicksail-stack
pnpm install
```sh
./scripts/install_dependencies.sh
```

### Development

Run the development server to start building your application.

> Make sure to give execute permissions to the script
```sh
chmod +x ./scripts/start_servers.sh
```

> Start development server
```sh
pnpm dev
./scripts/start_servers.sh
```

### Deployment
<!-- ### Deployment
Dockerize your application for deployment to production environments.
```sh
docker-compose up --build
```
``` -->

### License

Expand Down

0 comments on commit fc61b27

Please sign in to comment.