Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 4.24 KB

README.md

File metadata and controls

108 lines (72 loc) · 4.24 KB
Raw

Tracking 2024

📈 Analytics

🚀 Deployment Status

Branch CI/CD Status Url
Prod CircleCI prod-simple-tracking-2024.ghssidea.org/
Staging CircleCI staging-simple-tracking-2024.ghssidea.org/
Review CircleCI review-simple-tracking-2024.ghssidea.org/
Dev CircleCI dev-simple-tracking-2024.ghssidea.org/

Automated deployment schedule: CMS data are ingested to Staging weekly.

📄 Ingest Latest CMS Data from Airtable

  1. Click the "CI/CD Status" badge above next to the site where you want to update data
  2. Click "Trigger Pipeline" button on the top right section of that page.

👩‍💻 Local Development Quick start

Dependencies

Install Docker Desktop. Docker desktop must be running for the development commands to work.

Run project

docker compose up

This command starts the database (at port 5432) and the website (at http://localhost:8000/).

If AWS Credentials are not configured, you will need to provide an Airtable token and Mapbox API key:

GATSBY_MAPBOX_API_KEY='XXXX' AIRTABLE_API_KEY='XXXX' docker compose up

You can create an airtable token in the developers settings in airtable.



Ingest Tracking Database

While the database is running:

sh/restore-db

AWS CLI not found, please download database dump manually.

If you don't have AWS CLI or credentials, you will get a message saying "AWS CLI not found, please download database dump manually." In this case, download the tracking database dump file, name it dump-tracking, and place it in the ./data/dumps/ directory.

Port 5432 In Use

You may get an error saying the port is already in use if your system is already running postgres, if you get that message, shut down your instance of postgres first

Editing queries

While the project is running (docker compose up) and after the database has been restored (sh/restore-db) queries in the /data/queries/ directory will re-run and save changes to a CSV file with the same name in the /data/csv/ directory, and will be updated in the GraphQL server and changes will be hot-reloaded on the site.

New queries added to the /data/csv/ directory will run automatically and save output into a csv file with the same name in the /data/csv/ directory, and will be added to the GraphQL server.

Connect to Tracking DB

To connect using a graphical database management tool (e.g. dBeaver, pgAdmin):

host:      localhost
database:  tracking
username:  postgres
password:  1234

Graphiql query interface

While containers are running, visit:

http://localhost:8000/__graphql