https://github.com/scottbenton/dungeon-manager-api
https://github.com/scottbenton/dungeon-manager-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/scottbenton/dungeon-manager-api
- Owner: scottbenton
- Created: 2024-05-08T03:16:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-11T00:17:35.000Z (about 1 year ago)
- Last Synced: 2024-05-11T01:23:13.026Z (about 1 year ago)
- Language: Go
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dungeon Manager API
This is the API for Dungeon Manager, an application I am working on to make it easier for game masters playing tabletop role playing games like Dungeons and Dragons to share information with their players.
## Setup
### Create a MongoDB database
I'm using a free database directly from [mongodb](www.mongodb.com/), but you can use any host you prefer.
Once you go through setup, copy your connection string before continuing.
### Environment Variables
The following environment variables must be set to run this project.
When running the project locally, you can set your environment variables into a `.env` file
The MongoDB connection string is private, but if you are developing off of `apps.scottbenton.dev`, you can use the default `JWKS_URL` value provided below.
```
DUNGEON_MANAGER_CONNECTION_STRING=*private*
JWKS_URL=https://api.auth.scottbenton.dev/auth/jwt/jwks.json
```
### Running
Run `go run .` in order to start the API