Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion backend/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
**/node_modules
.env*
.DS_Store
.DS_Store
.vercel
.env*.local
35 changes: 35 additions & 0 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# QueueBot Backend

---

## 🚀 Getting Started

Follow these steps to get your local development environment up and running.

### 1. Environment Configuration
Create a `.env` file in the root directory and add the development credentials:

`BOT_TOKEN=your_development_bot_token`
`JWT_SECRET=your_jwt_secret_here`
Comment on lines +12 to +13
Copy link

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The environment variable examples in the README are missing quotes around the values. This could lead to parsing issues especially if values contain special characters. Consider formatting them as proper shell variable assignments with quotes, e.g., BOT_TOKEN="your_development_bot_token"

Suggested change
`BOT_TOKEN=your_development_bot_token`
`JWT_SECRET=your_jwt_secret_here`
`BOT_TOKEN="your_development_bot_token"`
`JWT_SECRET="your_jwt_secret_here"`

Copilot uses AI. Check for mistakes.

### 2. Install Dependencies
Install the required packages using npm:

```bash
npm install
```

### 3. Launch Dev Server
```bash
npm run dev
```

## 📁 API Routing

JWT check is toggled based on directory

| Directory | Access Level | Description |
| :--- | :--- |:----------------------------------------|
| `src/routes/public` | **Unprotected** | Open endpoints like `/auth`. |
| `src/routes/private` | **Authenticated** | Requires a valid JWT to access. |

Loading
Loading