LFX Organizations Dashboard

A simple dashboard to view and past records of organizations that have participated in LFX programs. This project helps contributors discover organizations, inspect historical participation, and decide where to contribute.

Requirements

• Node.js 22.x (required)
• Docker (latest stable)
• Docker Compose (latest stable)

Quick Start — Local Setup

1. Fork the repository on GitHub, then clone your fork locally:

cd lfxorganizations

2. Terminal 1 — start backend (run from project root):

docker compose build --no-cache
docker compose up

Wait until you see Server running successfully in the logs before proceeding.

3. Terminal 2 — start UI:

cd ui
cp .env.example .env
npm i
npm run dev

Open the URL shown by the frontend dev server (typically http://localhost:5173).

Data and Contributions

• Data files live in service/data/*.json. To fix inconsistencies or add records, edit the relevant JSON file and submit a PR.
• UI improvements, bug fixes, accessibility and responsive design changes are welcome.

When raising a PR:

• Fork the repo, create a branch (e.g. feature/brief-description or fix/issue-number).
• Commit with clear messages.
• Push the branch and open a Pull Request against the main repository.
• In the PR description include what changed, why, and any testing steps.

Example workflow:

git checkout -b feature/your-feature
# make changes
git add .
git commit -m "feat: short description"
git push origin feature/your-feature
# open PR on GitHub

Contribution Guidelines

• Edit JSON records under data/ to update organization data.
• For UI changes, modify files under ui/src/ and test with npm run dev.
• Provide reproducible steps for bugs and include screenshots or logs when helpful.
• Follow semantic commit messages and descriptive PR titles.

Notes

• Ensure Node version 22.x is used for the frontend.
• Run backend first (Terminal 1) and only start the frontend (Terminal 2) after the backend reports Server running successfully.

Open a Pull Request on the main repository with:

• Repo URL used for cloning: https://github.com/yashgoyal0110/lfxorganizations clear title describing the change

Thank you for contributing — your improvements make the dashboard more useful for the community.