30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# SprintPadawan
|
|
|
|
A lightweight real-time sprint planning tool. Built with Go, HTMX, and Turso (The FOSS DB, not the platform).
|
|
|
|
## Development
|
|
|
|
This project uses Go 1.26. If you use Nix, a flake is provided to set up the environment. You can load it with `nix develop` or `direnv allow`.
|
|
|
|
Available Make commands:
|
|
* `make dev`: Runs the development server.
|
|
* `make build`: Compiles everything into a single binary.
|
|
* `make clean`: Removes the binary.
|
|
|
|
When running locally without Docker, the application will create an `app.db` SQLite database file in your current working directory.
|
|
|
|
## Docker
|
|
|
|
The project includes a Docker setup for those who use it.
|
|
|
|
1. Create a `.env` file in the project root.
|
|
2. Set the `ROOT_DIR` variable to the directory on your host machine where you want the database to be saved.
|
|
|
|
Example `.env`:
|
|
ROOT_DIR=/home/user/sprintpadawan_data
|
|
|
|
3. Start the container:
|
|
docker compose up -d
|
|
|
|
The Docker container maps your host `ROOT_DIR` to `/data` inside the container. Sprint Padawan is permanently configured to write its database to `/data` when running in Docker.
|