diff --git a/README.md b/README.md index 179e690..49cb788 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,58 @@ +# How to deploy + +## Clone the repo +``` +git clone https://github.com/Absenin/absenin-web +``` + +## Install required deps +> pnpm +``` +pnpm install +``` +> npm +``` +npm install +``` +> yarn +``` +yarn install +``` + +## Add the .env file +> .env schema in here https://github.com/Absenin/absenin-web/blob/main/.env.example + +## Build the project +``` +pnpm run build +``` +> npm +``` +npm run build +``` +> yarn +``` +yarn run build +``` + +## Start the project +``` +pnpm run start +``` +> npm +``` +npm run start +``` +> yarn +``` +yarn run start +``` + +___ +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=Absenin/absenin-web&type=Date)](https://star-history.com/#Absenin/absenin-web&Date) + # Repository Licensed Under BSD-3-Clause license, Modification is possible while copyright and license notices must be preserved. Copyright © 2024 Vann-Dev