Skip to content

Commit

Permalink
docs: update README.md to make it easier to launch the project locally
Browse files Browse the repository at this point in the history
Signed-off-by: Esteban Baron <[email protected]>
  • Loading branch information
EstebanBAR0N committed Nov 21, 2023
1 parent 66aa4b4 commit e0895a8
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand All @@ -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).

```
```

0 comments on commit e0895a8

Please sign in to comment.