fp/README.md

64 lines
1.6 KiB
Markdown

# futureporn.net
[![Built with Devbox](https://www.jetify.com/img/devbox/shield_galaxy.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)
Source Code for https://futureporn.net
See ./ARCHITECTURE.md for overview
## Getting Started
I'm working towards a better development experience with devbox and Tilt. This process is in a state of flux and is likely to be broken.
The main gist is as follows
1. Install [devbox](https://www.jetify.com/devbox/docs/installing_devbox/)
2. Install development environment & packages using devbox.
devbox install
3. Start a local KIND Kubernetes cluster
make cluster
4. Start Tilt
make tilt
Tilt will manage the KIND cluster, downloading necessary docker containers and building the containers listed in the fp helm chart at ./Charts/fp. Making changes to these charts or the application code will update or re-build the images as necessary.
## Metrics Notes
Keeping track of metrics we want to scrape using Prometheus
### Uppy
https://uppy.fp.sbtp.xyz/metrics
## Development Mantras
### Move fast and break things
### Make it work, make it right, make it fast (in that order)
### Done is better than perfect
### If it looks like a duck and quacks like a duck, it is a duck.
### If the way is long, the way is wrong
### Good, Fast, Cheap. Pick two but not all three.
### Organizations are fractals
### Focus on what moves the needle
### Alligator energy (move slow and preserve things)
### Code is run more than it is read
### The computer doesn't care
### [ONE SHOT. ONE LIFE](https://www.youtube.com/watch?v=Rh-ohspuCmE)