Moped

A comprehensive project tracking platform for Austin's mobility projects

🛵 🗺 👷 🚌 🚧 🚴 📊

Resources

• About
• Documentation
• Backlog

Environments

• Production: https://mobility.austin.gov/moped/
• Staging: https://moped.austinmobility.io/moped/

For resources and updates, see the Mobility Project Database project index.

Quick start

Welcome to the 🛵 Moped codebase! Below is a step-by-step guide to help you get started by setting up the Moped environment.

Prerequisites

Before you begin, make sure you have the following installed on your system:

• Git: To clone the repository.
• Docker: Moped uses Docker for container management.
• Hasura CLI: Required for managing the Hasura cluster.

Setting Up Moped

1. Install Hasura CLI

   • Install the Hasura CLI by running the following command:

     curl -L <https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh> | bash
     

   • Ensure it installs version 2.42.0 or later.

2. Start the Hasura Cluster

   • Navigate to the moped-database directory:

     cd moped-database
     

   • Start the Hasura cluster using Docker:

     ./hasura-cluster start
     

   • If you encounter errors related to migrations, you can try the following:

     ./hasura_cluster start_only
     ./run_migrations
     ./hasura-cluster start
     

3. Run the Frontend React App

   • Navigate to the moped-editor directory:

     cd moped-editor
     

   • Install the necessary npm packages:

     npm install
     

   • Start the frontend development server:

     npm start
     

   • The application should open in your browser at https://localhost:3000/moped.

Troubleshooting

• Logging in: The SSO Button is expected to be disabled in the local environment. Use the external user sign-in option instead and request test credentials from a team member.

Learn more

• Database - the database that powers the Mobility Project Database suite
• Editor - web application which enables City staff to browse and edit mobility project data
• ArcGIS Moped Database Viewer - GIS map application that includes Moped Project Data as a layer (requires ArcGIS Online permissions)
• API - serverless Flask API, handling data operations and API requests
• auth - manages authentication using AWS Cognito, including JWT token generation and validation for secure access control
• etl - integration scripts for ArcGIS & Knack Data Tracker
• toolbox - collection of utilities and scripts designed for ad-hoc maintenance tasks

License

As a work of the City of Austin, this project is in the public domain within the United States.

Additionally, we waive copyright and related rights of the work worldwide through the CC0 1.0 Universal public domain dedication.

Built by Data & Technology Services at Austin Transportation & Public Works