The primary backend for Anime Skip, containing user preferences, episodes, shows... and of course timestamps!
Check out the API Playground for example usage and read the docs.
The project is written in Go. However, all builds are done in a docker container, so you only need Go installed for editor support.
go v18+
jq
to parse JSON for some run scripts- GNU
make
to execute theMakefile
docker
for building and running locallydocker-compose
for running a database when starting the appMake sure you have the
docker-compose
command, notdocker compose
. Create an alias for it if needed:alias docker-compose="docker compose"
ginkgo
CLI for running BDD-style unit testsgo install github.com/onsi/ginkgo/v2/ginkgo
make run # Run API, postgres database, and other services locally
make run-clean # Same as run, but start with an empty postgres database
make watch # Run everything, but restart when saving a file
make gen # Generate GraphQL server code after changing api/*.graphqls
make compile # Compile the application outside of docker to bin/server
make build # Build the latest development docker image
make test # Run unit tests
Feel free to add a section for your editor if it's not listed!
Install the golang extension. Make sure to follow the quick start to install extra CLI tooling the extension relies on!