diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index d5bf9a1..c3d9663 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -2,6 +2,9 @@ name: Build Test on: push: +permissions: + contents: read + jobs: build: runs-on: ubuntu-24.04 diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 477ce45..1263ef9 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -7,6 +7,9 @@ on: types: [completed] workflow_dispatch: +permissions: + contents: read + jobs: deploy: runs-on: ubuntu-latest diff --git a/README.md b/README.md index 1f0310d..a2780f4 100644 --- a/README.md +++ b/README.md @@ -1 +1,20 @@ -# Quest's Official Discord Bot +> [!NOTE] +> Quest's Discord Bot is in active development, feel free to help and contribute to the project! + +# Quest Discord Bot + +An opensource modern Discord Bot built for moderation, utilities and support! + +## Running locally + +1. Clone the repository. +2. Create a PostgreSQL database for this bot. +3. Create a `.env` file based on `.env.example` and fill in the required values. +4. Install dependencies with `pnpm install` +5. Deploy the commands with `pnpm run deploy` +6. Run the development server with `pnpm dev` +7. The bot is now live on Discord with registered commands! + +## AI declaration + +Claude (and sometimes ChatGPT) is used when I don’t know how to implement something or when something randomly breaks and I don't know how to fix it. Co-pilot is rarely used to make minimal automatic security fixes for common vulnerabilities.