diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89217148..daa7cb84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,22 @@ - Then push git push devolp new-branch + +# Set Up Locally: + +- Install Dependencies: + +```bash +npm install +``` +- Build the project: +```bash +npm run buld +``` +- Start dev server: +```bash +npm run dev +``` ## Learn More diff --git a/README.md b/README.md index fecdb46d..cb4ce922 100644 --- a/README.md +++ b/README.md @@ -95,10 +95,10 @@ git push origin branch-name 1. Install npm from browser(windows), using ``sudo apt install npm``(linux) in the terminal 2. In the root directory: `npm install` for downloading all the dependencies needed for the project 3. Run `npm run build` for building the project -4. Run `npm start` for starting the server (Amupedia is currently running on `localhost:3000`)
+ If you find the server unresponsive, Follow Step : 5 & 6 -5. Run `npm i sharp` to install sharp. -6. Run `npm run dev` This will start the server. +4. Run `npm i sharp` to install sharp. +5. Run `npm run dev` This will start the server on localhost:3000 Happy coding 😊 ### NOTE