Merge pull request #153 from OpenSourceFellows/chore/switch-to-pnpm

Switch from NPM to PNPM & a Bit of Clean Up

Author: barronbytes

CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing Guide
+
+Thank you for your interest in contributing to this project! 🎉  
+Please follow these steps to submit your contributions smoothly.
+
+## 🚀 Quick Start
+
+### 1. Fork the Repository
+
+Click the **"Fork"** button on the top right of this page to create a copy of the repository under your GitHub account.
+
+### 2. Clone Your Fork Locally
+
+```bash
+git clone https://github.com/YOUR-USERNAME/YOUR-FORK.git
+cd YOUR-FORK
+```
+
+### 3. Add the Original Repo as a Remote
+
+```bash
+git remote add upstream https://github.com/OpenSourceFellows/map-dashboard.git
+```
+
+### 4. Create a New Branch for Your Work
+
+    Never work directly on main or reuse old branches.
+
+```bash
+git checkout main
+git pull upstream main
+git checkout -b feature/your-feature-name
+```
+
+### 5. Make Your Changes
+
+Make your changes locally, and commit them:
+
+```bash
+git add .
+git commit -m "Add: brief description of your change"
+```
+
+### 6. Push the Branch to Your Fork
+
+```bash
+git push origin feature/your-feature-name
+```
+
+### 7. Open a Pull Request
+
+- Go to your fork on GitHub
+- Click “Compare & Pull Request”
+- Make sure the base repository is the original repo
+- Add a clear title and description
+- Submit the PR 🚀
+
+## 🔁 Keeping Your Fork Up-to-Date
+
+Before starting new work, always sync your fork:
+
+```bash
+git checkout main
+git fetch upstream
+git merge upstream/main
+git push origin main
+```
+
+## 🔧 Guidelines
+
+- [ ] One feature/bugfix per branch.
+- [ ] Write clear commit messages.
+- [ ] Test your changes before submitting.
+- [ ] Follow project coding conventions (if any).
+- [ ] Be kind in code reviews and comments.
+
+Thank you for contributing! 🙌

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright © 2025, Program Earth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -2,7 +2,7 @@
 
 A modern, interactive map dashboard built with React and Vite. This project provides a user-friendly interface for visualizing and interacting with geospatial data layers.
 
-![Map Web App Preview](./public/map-preview.png)
+![Map Web App Preview](./public/map-dashboard-preview.png)
 
 ## Features
 
@@ -16,34 +16,34 @@ A modern, interactive map dashboard built with React and Vite. This project prov
 ## Prerequisites
 
 - Node.js (v18 or higher recommended)
-- npm (v9 or higher)
+- pnpm (v9 or higher)
 
 ## Installation
 
 1. Clone the repository:
    ```sh
    git clone https://github.com/OpenSourceFellows/map-dashboard.git
-   cd map-dashboard/frontend
+   cd map-dashboard
    ```
 2. Install dependencies:
    ```sh
-   npm install
+   pnpm install
    ```
 
 ## Development
 
 To start the development server:
 
 ```sh
-npm run dev
+pnpm run dev
 ```
 
 The app will be available at `http://localhost:5173` by default.
 
 ## Project Structure
 
 ```
-frontend/
+main/
 ├── public/           # Static assets
 ├── src/              # Source code
 │   ├── components/   # UI and map components
@@ -75,11 +75,8 @@ frontend/
 
 ## How to Contribute
 
-1. Clone the repository
-2. Create a new branch (`git checkout -b feature/your-feature`)
-3. Commit your changes
-4. Push to your branch and open a pull request
+[CONTRIBUTING.md](CONTRIBUTING.md)
 
 ## License
 
-This project is open source and available under the MIT License.
+[LICENSE.md](LICENSE.md)

CODE_QUALITY_REPORT.md docs/CODE_QUALITY_REPORT.mdCODE_QUALITY_REPORT.md renamed to docs/CODE_QUALITY_REPORT.md

@@ -0,0 +1,33 @@
+1. **Review in GitHub UI**:
+
+   - Check "Files changed" tab.
+   - Comment on lines if needed.
+   - Approve or request changes.
+
+2. **Check out the PR locally (optional)**:
+   If you want to test it locally:
+
+   ```bash
+   gh pr checkout <PR-number>
+   ```
+
+3. **Merge strategy:**
+
+- Use Squash and Merge to keep history clean.
+- Optionally delete the contributor’s branch (GitHub asks this by default).
+
+---
+
+### 🔁 If the Contributor Will Submit More Work
+
+- Remind them to:
+  - Create a new branch for each PR.
+  - Keep their fork synced regularly.
+
+---
+
+### 🧪 Optional: Automation Tools to Consider
+
+- GitHub Actions – for linting, testing, or builds.
+- PR Labelers – auto-label PRs.
+- CODEOWNERS – assign reviewers automatically.