Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 2.83 KB

README.md

File metadata and controls

65 lines (42 loc) · 2.83 KB
Raw

Queering the Map

Queering the Map is a community-based platform where individuals anonymously pin their queer experiences and stories to specific locations on a global map.

Setup

You have two options for setting up the project: a quick setup for frontend-only work or a full setup with Supabase.

Option 1: Quick Setup for Frontend-Only Work

This approach is quicker and allows you to work on the frontend without setting up Supabase. Note that popups will not show text if you choose this option.

  1. Install dependencies with npm ci.
  2. Run the seed script to generate mock data: npm run seed-data.
  3. Copy .env.example into .env: cp .env.example .env.

Option 2: Full Setup with Supabase

This approach is necessary if you want to work also work on the backend. It takes longer to set up but provides a complete development environment, aligned with what we use in production.

  1. Install dependencies with npm install.
  2. Set up a Supabase (local) project with the official CLI.
  3. 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.
  4. Run the DB migrations locally with supabase db reset.
  5. Fetch the data from Supabase: npm run fetch-data.

Developing

To start a development server:

npm run dev

Testing

For testing the database make sure that the pgTap extension is enabled in postgres (more info). Afterwards, you can run: supabase test db.

Deploying and Building for 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.

To create a production version of the app:

npm run build

Set up Captcha Protection

For Captcha protection of the point submissions, we use Cloudflare Turnstile. Once you create a widget there, populate the correct values for the env variables:

PUBLIC_CLOUDFLARE_TURNSTILE_SITE_KEY
CLOUDFLARE_TURNSTILE_SECRET

For more info, see this guide: https://developers.cloudflare.com/turnstile/get-started/.