diff --git a/README.md b/README.md index d599bee..7c9d90c 100644 --- a/README.md +++ b/README.md @@ -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. - +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 + ### License