fp/README.md
CJ_Clippy c71cadd589
Some checks failed
ci / build (push) Successful in 10m58s
ci / Tests & Checks (push) Has been cancelled
builder.yml fixes
2025-02-13 12:49:05 -08:00

52 lines
1.5 KiB
Markdown

# futureporn.net
![Tests Status](https://gitea.futureporn.net/futureporn/fp/actions/workflows/tests.yaml/badge.svg)
![Build Status](https://gitea.futureporn.net/futureporn/fp/actions/workflows/builder.yaml/badge.svg)
![Elixir](https://img.shields.io/badge/elixir-%234B275F.svg?style=for-the-badge&logo=elixir&logoColor=white)
![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)
[![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 an overview of the infrastructure components.
## Getting Started
The main gist is as follows.
1. install [docker](https://docs.docker.com/engine/install) `wget -O- get.docker.com | bash`
1. Install [devbox](https://www.jetify.com/devbox/docs/installing_devbox/) `curl -fsSL https://get.jetify.com/devbox | bash`
2. Install development environment & packages using devbox.
devbox install
3. Run `docker compose up --watch`
4. Visit http://localhost:4000
If all went well, editing source code will automatically affect the website running in your browser.
## backup/restore dev database
@see https://stackoverflow.com/a/29913462/1004931
### backup
Use devbox helper script
devbox run backup
### restore
cat ./backups/your-backup.sql | docker exec -i postgres_db psql -U postgres
## Metrics Notes
Keeping track of metrics we want to scrape using Prometheus