Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 3.29 KB

README.md

File metadata and controls

90 lines (60 loc) · 3.29 KB
Raw

Mobility Marketplace

camobilitymarketplace.org

A one-stop resource for modern, equitable and accessible public transit products and services.

Deployed via Netlify Netlify Status

Development

Cloning the repository

You can run the usual git clone command to check out this project, but notice that this repo contains Git submodules. To ensure you have all the files in those submodules, you can pass --recuse-submodules when cloning:

git clone --recurse-submodules https://github.com/cal-itp/mobility-marketplace.git

or if you've already cloned the project, you can run:

git submodule update --init

Running a local instance

This is a Jekyll static site. We include a Devcontainer configuration to help with local testing and development.

  1. Open the repository directory in VS Code
  2. Ctrl/Cmd+Shift+P to bring up the Command Palette
  3. Enter Remote-Containers to filter the command list
  4. Enter or select Rebuild and Reopen in Container to start from scratch
  5. Enter or select Reopen in Container to reopen the last devcontainer used

Once inside the devcontainer, you have the manually start the site:

  1. Ctrl/Cmd+Shift+P to bring up the Command Palette
  2. Enter Tasks: Run Task
  3. Enter or select Jekyll: Build Dev
  4. Open the app on http://127.0.0.1:4000/*

Auto rebuild/reload will be active and will watch the site files for changes.

* Try using cmd and clicking on the server address from the Terminal

Debugging the Transit Providers CSV file

The automated process to fetch providers from the data warehouse consists of two parts. The first part is downloading the data as a CSV file from the warehouse. The second part is preparing the data with some Python.

# Download the data
bash .github/resources/download_csv.sh

# (Optional) Don't pollute your global Python install
virtualenv .github/resources/venv
source .github/resources/venv/bin/activate

# Install Python dependencies
pip install -r .github/resources/requirements.txt

# Run the Python script with all the preparing logic
python .github/resources/process_providers.py

Documents

This site uses Google Cloud to manage static files, like the PDFs on the How To pages.

Requirements: User must be authorized on Google Cloud to access the resources-calitp-org bucket.

  1. Go to https://cloud.google.com/
  2. Click Console
  3. Click Cloud Storage
  4. Click resources.calitp.org
  5. Click mobility-marketplace
  6. Click button for action needed: Upload Files, Delete or Edit on a particular file

License

Content (including graphics, images, video, documents, and text) in this repository is licensed under CC-BY 4.0.

The source code in this repository used to format and display the content is licensed under GPL-3.0.