Comaps

A platform for creating and visualising community maps.

It is available to use at comaps.radicaldata.org.

Install

1. Clone the repository: git clone https://github.com/radical-data/comaps.git
2. Navigate to the project folder: cd comaps.
3. Install dependencies: npm install.
4. Set up a Supabase (local) project with the official CLI.
5. Set the environment variables.
   1. Copy the .env.example file to .env (manually or with cp .env.example .env).
   2. Get your SUPABASE_URL and SUPABASE_ANON_KEY from the output of supabase start.
6. Run the DB migrations locally with supabase db reset.
7. Fetch the data from Supabase: npm run fetch-data.

Develop

To develop Comaps locally:

1. Start a development server: npm run dev.
2. Comaps will be running locally at http://localhost:5173/.

Build

To create a production version of Comaps:

1. Build it: npm run build.
2. (Optional) You can preview the production build with npm run preview.

Deploying to Production

To use Supabase as a remote backend make sure to link your local development with your remote Supabase project:

1. Make sure you have a Supabase acount and connect it to the supabase cli: supabase login
2. Link a specific remote project supabase link --project-ref <project-ref> (more info)
3. Run migrations on remote DB supabase db push (more info)
4. Make sure that the env vars SUPABASE_URL and SUPABASE_ANON_KEY do point to the correct production project and not the local containers. You can grab them from inside your Supabase project's dashboard.

Sharing feedback

Your feedback helps us improve Comaps! If you have feature requests or find bugs, please open an issue.