Skip to content

Commit

Permalink
#43 Add some basic information in the README about deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
danielemery committed Sep 23, 2023
1 parent 05c7266 commit 58ba641
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# QuizLord API
# Quizlord API

Graphql api for sharing newspaper quizzes between friends, including results and statistics

Follows the [GraphQL Cursor Connections Specification](https://relay.dev/graphql/connections.htm).

# Deployment

The api is packaged in docker and deployed with github actions to the (github registry)[https://github.com/danielemery/quizlord-api/pkgs/container/quizlord-api].
A helm template is also deployed with a github action to https://helm.demery.net.

See (quizlord-stack)[https://github.com/danielemery/quizlord-stack] for further details about deployment and for the terraform module.

# Local Development

Doppler is used to provide access to secrets, in order to run the app you first need to run
Expand Down

0 comments on commit 58ba641

Please sign in to comment.