Skip to content

Commit 7cc83fb

Browse files
Address feedback
- Include dashboard-server setup instructions to README - Clarify GitHub CLI requirements in MAINTAINER.md - Add links to GitHub CLI installation docs
1 parent 2798dc7 commit 7cc83fb

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,18 @@ A modern, interactive map dashboard built with React and Vite. This project prov
2626
git clone https://github.com/OpenSourceFellows/map-dashboard.git
2727
cd map-dashboard
2828
```
29+
2930
2. Install dependencies:
3031
```sh
3132
pnpm install
3233
```
3334

35+
3. **Optional**: For full development setup, you may also need the companion backend server:
36+
```sh
37+
git clone https://github.com/OpenSourceFellows/dashboard-server.git
38+
```
39+
See the [dashboard-server repository](https://github.com/OpenSourceFellows/dashboard-server) for backend setup instructions.
40+
3441
## Development
3542

3643
Start the development server:

docs/MAINTAINER.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,15 @@ git checkout -b <type>/<descriptive-name>
2222

2323
## Creating Pull Requests
2424

25-
Create PRs for changes using GitHub CLI:
25+
Push your branch:
2626

2727
```bash
28-
# Push your branch
2928
git push -u origin <your-branch-name>
29+
```
30+
31+
Create PR using [GitHub CLI](https://cli.github.com/) (requires installation):
3032

31-
# Create PR (uses PR template)
33+
```bash
3234
gh pr create --title "Your PR title" --fill
3335
```
3436

@@ -42,7 +44,7 @@ gh pr create --title "Your PR title" --fill
4244

4345
### 2. Check out PR locally (optional)
4446

45-
If you want to test it locally:
47+
If you want to test it locally, use [GitHub CLI](https://cli.github.com/):
4648

4749
```bash
4850
gh pr checkout <PR-number>

0 commit comments

Comments
 (0)