From a9811287d2a09ff8ba32f817869ef843c72bdb5b Mon Sep 17 00:00:00 2001 From: n-d-r-d-g Date: Sun, 4 Aug 2024 19:45:44 +0400 Subject: [PATCH 1/2] Added contribution steps in README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 10df7626..ea893baf 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,20 @@ 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 `cd packages/frontendmu-nuxt`. +6. Run `pnpm run 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 From 747945651a5b23c5379253e067ab6cf6d3d06ce8 Mon Sep 17 00:00:00 2001 From: n-d-r-d-g Date: Sun, 4 Aug 2024 19:59:40 +0400 Subject: [PATCH 2/2] Updated README with suggestions --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index ea893baf..dbf71901 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,7 @@ cp .env.example .env.development 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 `cd packages/frontendmu-nuxt`. -6. Run `pnpm run dev`. +5. Run `pnpm run nuxt dev`. ### Submit your PR