Refactor: Update README, NavBar, Drizzle schema, and environment types

This commit is contained in:
aronmal 2024-01-29 10:49:29 +01:00
parent 757d790e54
commit 6b07599a68
Signed by: aronmal
GPG key ID: 816B7707426FC612
4 changed files with 22 additions and 11 deletions

View file

@ -49,23 +49,30 @@ To get started with li'l Judd, follow the instructions below.
VITE_DISCORD_CLIENT=your_discord_client_id
VITE_DISCORD_CLIENT_SECRET=your_discord_client_secret
VITE_DISCORD_BOT_TOKEN=your_discord_bot_token
VITE_DISCORD_BOT_PERMISSIONS=18977581952080
VITE_AUTH_SECRET=your_auth_secret
VITE_DATABASE_URL=your_database_url
```
#### Development
Recieve your discord applications client id & secret, as well as the bot token from the [Applications dashboard](https://discord.com/developers/applications/).
Specify `VITE_AUTH_REDIRECT_PROXY_URL` only if necessary, particularly when setting up a reverse proxy to test authentication with callbacks to your development box. [Auth.js Docs Reference](https://authjs.dev/reference/nextjs/#redirectproxyurl)
How to generate your `VITE_AUTH_SECRET` with [`openssl rand -base64 32`](https://authjs.dev/reference/core#secret).
The duplicate `DATABASE_URL` is only needed for Drizzle Studio.
Composite your `VITE_DATABASE_URL` like [`postgres://postgres:adminadmin@0.0.0.0:5432/db`](https://orm.drizzle.team/docs/get-started-postgresql#postgresjs).
```
VITE_AUTH_REDIRECT_PROXY_URL=your_auth_redirect_proxy_url
#### Development
DATABASE_URL=your_database_url
```
Specify `VITE_AUTH_REDIRECT_PROXY_URL` only if necessary, particularly when setting up a reverse proxy to test authentication with callbacks to your development box. [Auth.js Docs Reference](https://authjs.dev/reference/nextjs/#redirectproxyurl)
The duplicate `DATABASE_URL` is only needed for Drizzle Studio.
```
VITE_AUTH_REDIRECT_PROXY_URL=your_auth_redirect_proxy_url
DATABASE_URL=your_database_url
```
### Usage
@ -120,6 +127,6 @@ If you'd like to contribute to li'l Judd, feel free to open an issue or submit a
## License
This project is licensed under the [MIT License](LICENSE).
This project is licensed under the [GPL v3 License](LICENSE).
Happy splatting! 🦑🎮