docs: update README.md to make it easier to launch the project locally

Signed-off-by: Esteban Baron <[email protected]>
priyankarpal · Nov 21, 2023 · 16afc67 · 16afc67
1 parent 66aa4b4
commit 16afc67
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,22 @@ The main aim of ProjectsHut is to foster a collaborative community of creative i
 - [Typescript](https://www.typescriptlang.org) - TypeScript is a free and open-source high-level programming language.
 - [TailwindCSS](https://tailwindcss.com) - Tailwind CSS is a utility-first CSS framework for rapidly building modern websites without ever leaving your HTML.
 
+## 👩‍💻 Run the project locally
+
+Start project :
+
+```bash
+pnpm install && pnpm run build
+```
+
+Start the project :
+
+```bash
+pnpm run start
+```
+
+Finally, visit http://localhost:3000 on your favourite browser 🌐.
+
 ## 🚀 Quick start
 
 Contributions are welcome! If you have any ideas, suggestions, or bug fixes, please open an [issue](https://github.com/priyankarpal/ProjectsHut/issues/new/choose) or submit a pull request. Make sure to follow the project's code of conduct.