diff --git a/README.md b/README.md index 10df7626..dbf71901 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,19 @@ cp .env.example .env.development ``` ## Feel free to contribute :D + +### Run the project locally + +1. Fork the repository to get your copy on your account. +2. Clone your forked repository on your machine. +3. Open the cloned `frontend.mu` directory in your code editor. +4. Run `pnpm install` in your terminal. +5. Run `pnpm run nuxt dev`. + +### Submit your PR + +1. Commit & push your changes on your forked repository. +2. Log in to your GitHub account & go to your forked repository's page. +3. On the `Code` tab, click `Contribute` and then `Open a pull request` to submit your PR ([read more about this](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project#making-a-pull-request)). + +**Chat with us on [Discord](https://discord.gg/WxXW9Jvv6k?ref=frontend.mu) if you're having any issue! ✌️** \ No newline at end of file