https://github.com/quantgeekdev/feed-a-dev-backend
Tool for sending coffee & snacks to tired devs
https://github.com/quantgeekdev/feed-a-dev-backend
Last synced: 5 months ago
JSON representation
Tool for sending coffee & snacks to tired devs
- Host: GitHub
- URL: https://github.com/quantgeekdev/feed-a-dev-backend
- Owner: QuantGeekDev
- Created: 2024-10-23T19:17:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-25T00:03:46.000Z (over 1 year ago)
- Last Synced: 2025-03-24T04:35:52.307Z (11 months ago)
- Language: Rust
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# feed-a-dev-backend
Automates getting coffee and snacks for tired devs
# API Endpoints
### [Link to postman collection](https://elements.getpostman.com/redirect?entityId=17880741-ce517d06-08c1-43e3-be29-99c28e898c42&entityType=collection)
## Auth Routes
| Method | Endpoint | Description | Auth Required | Request Body |
|--------|----------|-------------|---------------|--------------|
| POST | `/register` | Register new user (developer) | No | `{ "username": string, "password": string, "role": "developer" }` |
| POST | `/register` | Register new user (project manager) | No | `{ "username": string, "password": string, "role": "project_manager" }` |
| POST | `/login` | Authenticate user and get JWT | No | `{ "username": string, "password": string }` |
## Snack Routes
| Method | Endpoint | Description | Auth Required | Request Body |
|--------|----------|-------------|---------------|--------------|
| POST | `/snack` | Create new snack | Yes | `{ "name": string, "category": string, "price": decimal, "image_url": string }` |
| PATCH | `/snack/{id}` | Update snack (owner/admin) | Yes | `{ "name"?: string, "category"?: string, "price"?: decimal, "image_url"?: string }` |
| DELETE | `/snack/{id}` | Delete snack (owner/admin) | Yes | None |
| GET | `/snacks` | List snacks (filtered by role) | Yes | None |
## Relationship Routes
| Method | Endpoint | Description | Auth Required | Request Body |
|--------|----------|-------------|---------------|--------------|
| POST | `/invite-pm` | Developer invites PM | Yes | `{ "project_manager_id": integer }` |
| PATCH | `/respond-to-invite/{id}` | PM accepts/rejects invite | Yes | `{ "status": "accepted" \| "rejected" }` |
| GET | `/my-developers` | PM lists accepted developers | Yes | None |
## Authentication
Use Bearer token in Authorization header:
```
Authorization: Bearer
```
## Response Types
### User
```typescript
{
id: number
username: string
role: "developer" | "project_manager" | "admin"
created_at: string
updated_at: string
}
```
### Snack
```typescript
{
id: number
name: string
category: string
price: decimal
image_url: string
created_at: string
updated_at: string
user_id: number
}
```
### Relationship
```typescript
{
id: number
developer_id: number
project_manager_id: number
status: "pending" | "accepted" | "rejected"
created_at: string
updated_at: string
}
```