fAIr Documentation

Appearance

Getting Started with fAIr ​

Welcome! This guide will help you set up the fAIr project for local development and contribution.

Prerequisites ​

  • Node.js (v18+ recommended)
  • npm (comes with Node.js)
  • Git
  • Docker (for backend and database services)
  • (Optional) Python 3.9+ and pip (for advanced backend work)

1. Clone the Repository ​

sh
git clone https://github.com/hotosm/fAIr.git
cd fAIr

2. Install Frontend Dependencies ​

sh
cd frontend
npm install

3. Run the Frontend Locally ​

sh
npm run dev
  • Visit the port shown in your terminal to view the app.

4. Run the Documentation Locally ​

sh
npm run docs:dev
  • Visit the port shown in your terminal to view the docs.

5. Start Backend and Database (with Docker) ​

From the project root:

sh
docker compose -f docker-compose.prod.yml up
  • This will start the backend API, database, and related services.

6. Environment Variables ​

  • Copy and edit environment files as needed (see .env.example in backend and frontend).
  • For OSM integration, set up your OSM OAuth credentials as described in the User Manual.

7. Useful Commands ​

  • Stop all Docker services:
    sh
    docker compose down
  • Build docs for production:
    sh
    npm run docs:build
  • Deploy docs to GitHub Pages:
    sh
    npm run docs:deploy

8. Contributing ​

Need Help? ​

Happy mapping!