setup-local-machine.md

Setup Local Machine

Requirements

• nvm
• Docker

Setup

1. Clone the repository
2. (Optional) Append ./git-hooks/post-merge to .git/hooks/post-merge
3. Configure environment variables: Duplicate app/.env.example to app/.env and fill in the blanks.
4. Start up the database: docker compose up
5. Open a second terminal and change to app directory: cd app
6. Install required Node.js version: nvm install
7. Install dependencies: npm ci
8. Update the database's schema: npx prisma migrate dev
9. Run the app: npm run dev
10. Access the app at: http://localhost:3000

(Experimental) Dev Container

1. Install the Dev Containers extension for VSCode
2. Dev Containers: Reopen In Container and wait for it to finish
3. Go to your VSCode extensions and enable the recommended ones
4. (Optional) Install your personal VSCode extensions in Dev Container
   • You'll need to do this after every rebuild of the container
5. Update the database's schema: npx prisma migrate dev
6. Run the app
   • Terminal: npm run dev
   • VSCode debugger: F5
7. Access the app at: http://localhost:3000

Bot Invite Link with required scopes

• https://discord.com/api/oauth2/authorize?client_id=XXX&permissions=0&scope=bot