Monorepo for panfactum
Commands
| Command | Description |
|---|---|
dev up |
Launches utilities needed to power the local development environment |
dev down |
Resets your local development environment entirely by stopping background utilities and deleting ALL of the data and built images |
deploy-marketing |
Deploys the marketing site (panfactum.com) from the local code (requires setting up panfori-root AWS profile) |
Sites
| URL | Description |
|---|---|
localhost |
Marketing site |
locahost/healthz |
Healthcheck for ingress-nginx |
localhost/docs |
Internal documentation site |
localhost/app |
Local deployment of app, the main SPA for users |
localhost/api |
Local deployment of api, the main API server |
localhost/api/docs |
Swagger docs for api |
localhost/pgadmin4 |
Automatically configured postgres GUI |
TCP Tunnels
| URL | Description |
|---|---|
localhost:35000 |
The local container registry used in the kind cluster |
| TBD | The postgres database backing API |
Our DX goals:
-
a single command for launching a development environment that works the same for all engineers:
dev up -
a single command for resetting the entire development environment :
dev down -
an interative UI for all other workflows via tilt
These goals are achieve through a combination of four key utilities:
-
devenv - A wrapper around nix that
-
Automatically downloads and updates all of the dependencies you need for local development
-
Automatically configures your local shell with environment variables, git hooks, and convenience scripts
-
Ensures that all developers are using the exact same versions and binaries
-
-
podman - A linux pod and container management technology that
-
That servers as a docker drop-in (can be used with docker tools such as docker-compose and lazydocker
-
Can run daemonless and in a secure rootless mode that doesn't force you to introduce security gaps on your host machine
-
Is linux-native and FOSS software
-
-
kind - A tool for launching local kubernetes clusters (Kubernetes IN Docker)
-
Allows local development to more closely resemble our integration and production environments
-
Allows for significant code and tool reuse
-
-
tilt - A local-first CI/CD manager that
-
Automates all of our local development workflows including image building, deployment of infrastructure, and hot-reloading
-
Provides a convenient web UI that allows us to quickly switch between and debug different components of the stack
-
Note: Local development paradigm is optimized for linux-based development systems. Support for other systems is a future project.
-
You MUST complete this setup guide BEFORE you start developing against this project.
-
Run
dev upto launch the development environment -
Open a new
gitbranch viagit checkout -b <branch_name> -
Make code changes
-
Test the changes
-
Visit the sites (see above); hot-reloading should always be enabled
-
Run testing and linting (see the Tilt UI)
-
Use
k9sto view the local cluster and gather debugging information
-
-
Commit your changes; ensure the pre-commit hooks are passing
-
Open a PR