From e0895a83624869f310a61c9d2e7838beb6196c9f Mon Sep 17 00:00:00 2001 From: Esteban Baron Date: Tue, 21 Nov 2023 15:49:41 +0100 Subject: [PATCH] docs: update README.md to make it easier to launch the project locally Signed-off-by: Esteban Baron --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 245d900e5..fa1941d8b 100644 --- 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. @@ -28,7 +44,7 @@ Contributions are welcome! If you have any ideas, suggestions, or bug fixes, ple - Go through the [CONTRIBUTING.md](https://github.com/priyankarpal/ProjectsHut/blob/main/contributing.md) file, where all the guidelines have been mentioned that will guide you to make your contribution. - Do check out the [project issue tracker](https://github.com/priyankarpal/ProjectsHut/issues) section. -- we are using `pnpm` so please use `pnpm` +- we are using `pnpm` so please use `pnpm` ## 🤝 Our Contributors @@ -54,3 +70,7 @@ We value the time and effort you put into contributing, and we look forward to r ## Šī¸ License The project is licensed under the [MIT License](https://github.com/neelshah2409/Bot-Collection/blob/main/LICENSE). + +``` + +```