Skip to content

Developer Setup

1. Programs to install

poetry git-secret Docker Desktop

2. Set up git-secret

3. Setup the project

git clone https://github.com/datapointchris/ichrisbirch.git

cd ichrisbirch/

git secret reveal

poetry install

source .venv/bin/activate

export ENVIRONMENT=development

pre-commit install

# Make sure Docker is running

pytest

4. Run the project

TODO

This doesn't work! I need to figure out another way to run it locally. Right now it is relying on using local NGINX and Supervisor.

# App and API are separate applications.
# App is a flask app that runs the frontend
# API is FastAPI running the API backend that the frontend connects to

# Run these in separate shells for log separation
# poetry run python ichrisbirch/runapidev.py
# poetry run python ichrisbirch/runappdev.py

5. Connecting to the Running Project

5.1. App

http://127.0.0.1:6000

5.2. API

http://127.0.0.1:6200

GitHub - github/scripts-to-rule-them-all: Set of boilerplate scripts describing the normalized script pattern that GitHub uses in its projects.