HannahTalksDev / HannahTalksDev/MedicineSymptomLookup
GROUP 2 - Add extra information to documentation on installing packages before running code
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## Add local development instructions to README
**Problem:**
Our documentation is missing instructions on how to run the code locally.
**Task:**
Add documentation for running the application in the local environment.
1. Go to `README.md`
2. After step 2 (Install dependencies), add the following section:
````markdown
### 3. Run the development server
```bash
npm run dev
```
````
**Hint:** Add below step 2:
---
**Submission Instructions:**
1. Checkout a new branch: `git checkout -b #2/add-dev-instructions`
2. Make the changes described above
3. Stage changes: `git add .`
4. Commit: `git commit -m "Add local development instructions to README"`
5. Push branch: `git push origin #2/add-dev-instructions`
6. Create a pull request against `main` on GitHub (remember to select your own branch)
Contributor guide
Assessment
This issue has not been assessed yet.