Create a Project — Authenticated Backend Example

Background

This script is provided as an example for interacting with the MapSwipe backend.

Caution

Ongoing updates to the backend might render this script out-of-date.

Utility script: run.py

Real-world usage

Getting started

Note

You will need Manager account credentials to run this script.

Important

You do not need manager account credentials for read-only access.
After setting ENABLE_AUTHENTICATION to false, you can run the read-only part of the script.
https://github.com/mapswipe/mapswipe-docs/blob/main/examples/create-project/run.py#L444-L460

  • Create .env file.
  • Define the following variables:
    • MANAGER_URL: URL for Manager Dashboard
    • BACKEND_URL: URL for Backend
    • CSRFTOKEN_KEY: CSRF Token Key
    • ENABLE_AUTHENTICATION
    • FB_AUTH_URL: Authentication URL
    • FB_USERNAME: Manager account username
    • FB_PASSWORD: Manager account password
  • For FB_AUTH_URL,

Alpha Instance

Caution

The alpha instance is running inside Togglecorp’s domain for internal testing.

Your final .env for alpha instance should look like this:

MANAGER_URL=https://manager-2.mapswipe.dev.togglecorp.com
BACKEND_URL=https://backend-2.mapswipe.dev.togglecorp.com
CSRFTOKEN_KEY=MAPSWIPE-ALPHA-2-CSRFTOKEN

ENABLE_AUTHENTICATION=true
FB_AUTH_URL=https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
# Your web-app login credential
FB_USERNAME=me@example.com
FB_PASSWORD=my-very-good-password

Staging Instance

Your final .env for staging instance should look like this:

MANAGER_URL=https://managers-stage.mapswipe.org
BACKEND_URL=https://backend-stage.mapswipe.org
CSRFTOKEN_KEY=MAPSWIPE-STAGE-CSRFTOKEN

ENABLE_AUTHENTICATION=true
FB_AUTH_URL=https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
# Your web-app login credential
FB_USERNAME=me@example.com
FB_PASSWORD=my-very-good-password

Caution

This will create dummy projects in the staging environment set in the script.

Production Instance

Your final .env for production instance should look like this:

MANAGER_URL=https://managers.mapswipe.org
BACKEND_URL=https://backend.mapswipe.org
CSRFTOKEN_KEY=MAPSWIPE-PROD-CSRFTOKEN

ENABLE_AUTHENTICATION=false
FB_AUTH_URL=https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
# Your web-app login credential
FB_USERNAME=me@example.com
FB_PASSWORD=my-very-good-password

Caution

Do not use this credential with the provided script, as it will create dummy projects in the production environment.

Running the script

Run the example script using uv

uv run run.py

Note

To install uv, visit https://docs.astral.sh/uv/getting-started/installation/

To Generate GraphQL Query

Use the running alpha instance to create the queries you need: https://backend-2.mapswipe.dev.togglecorp.com/graphiql/

Legacy datasets

Access the legacy datasets here: assets/legacy-datasets