Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/floffah/dndnotes
🗺️ Advanced DND note-taking webapp for both sides of the equation
https://github.com/floffah/dndnotes
cms discord dungeons-and-dragons embedded-app notebook webapp
Last synced: about 1 month ago
JSON representation
🗺️ Advanced DND note-taking webapp for both sides of the equation
- Host: GitHub
- URL: https://github.com/floffah/dndnotes
- Owner: Floffah
- License: mit
- Created: 2023-11-19T21:53:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-13T23:26:58.000Z (9 months ago)
- Last Synced: 2024-04-14T13:10:41.919Z (9 months ago)
- Topics: cms, discord, dungeons-and-dragons, embedded-app, notebook, webapp
- Language: TypeScript
- Homepage: https://dndnotes.floffah.dev
- Size: 5.39 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DNDNotes
## Development
### Discord activity
> [!NOTE]
> Discord activity development is paused, this section is not necessary
To get tunnels set up for your discord activity, you need to do the following:
```shell
brew install cloudflared # install cloudflare tunnel service
cloudflared login # login to your cloudflare account - make sure to give it access to one of your domains here
cloudflared tunnel create discord-activity # create a tunnel named dndnotes
cloudflared tunnel route dns discord-activity dndatunnel.floffah.dev # replace domain with your own
cloudflare tunnel create dndnotes-web # create a tunnel named dndnotes-web
cloudflare tunnel route dns dndnotes-web dndnotestunnel.floffah.dev # replace domain with your own
yarn dev # start the dndnotes web dev server (where the api is hosted) and the discord-activity frontend dev server
yarn tunnel # start the cloudflare tunnels
```
Then link these domains to discord. In your developer dashboard, go to the "URL Mappings" tab and add the following mappings: (replace the domains with your own)
- `/` - dndatunnel.floffah.dev
- `/dndnotes` - dndnotestunnel.floffah.dev
- `/icons` - api.iconify.design
- `/pubnub` - ps.pndsn.com
### Environment variables
#### Web
(Replace with correct values)
```properties
DISCORD_BOT_TOKEN="token"
DISCORD_CLIENT_SECRET="secret"
NEXT_PUBLIC_BASE_URL="https://dndnotes.app" # no trailing slash
NEXT_PUBLIC_DISCORD_CLIENT_ID="client id"
NEXT_PUBLIC_DISCORD_REDIRECT_URI="https://dndnotes.app/api/auth/callback/discord"
PLANETSCALE_DB_HOST=aws.connect.psdb.cloud
PLANETSCALE_DB_USERNAME=username
PLANETSCALE_DB_PASSWORD=pscale_pw_somepassword
PLANETSCALE_DB=dndnotes
```
#### Server
Only requires credentials for a test database, should NOT be a database used for production or local testing as it will unpredictably wipe data.
```properties
TEST_DB_HOST=aws.connect.psdb.cloud
TEST_DB_USERNAME=username
TEST_DB_PASSWORD=pscale_pw_somepassword
TEST_DB=dndnotes
```