https://github.com/dvrpc/sidewalk-priorities-api

https://github.com/dvrpc/sidewalk-priorities-api

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dvrpc/sidewalk-priorities-api
• Owner: dvrpc
• License: gpl-3.0
• Created: 2021-09-29T14:03:39.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-09-17T20:22:20.000Z (9 months ago)
• Last Synced: 2025-10-13T22:22:39.541Z (8 months ago)
• Language: Python
• Size: 41 KB
• Stars: 1
• Watchers: 10
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# sidewalk-priorities-api

API backend for the Sidewalk Priorities webmap.

## Development Environment Setup

Create the virtual environment:

```

python -m venv env

```

Activate the environment:

```

source env/bin/activate

```

Install requirements:

```

pip install -r requirements.txt

```

## Configuration

Create a `.env` file that defines a `DATABASE_URL` and `URL_ROOT` as shown below, or otherwise declare them as a system variables.

```

DATABASE_URL = postgresql://username:password@host:port/database

URL_ROOT = /api/mcosp/v1

```

## Run the API

Run the API locally:

```

uvicorn src.main:app --reload

```