Started BE structure / docker for FE dev
This commit is contained in:
@@ -0,0 +1,55 @@
|
||||
# Cover letter templater
|
||||
|
||||
Generates cover letters based on a template, and job listening using OpenAI.
|
||||
|
||||
## Stack
|
||||
|
||||
- Frontend:
|
||||
- `Reactjs`
|
||||
- `Tailwindcss`
|
||||
- `Mantine` component library
|
||||
- TanStack `Router` + `Query` + `Forms`
|
||||
- Backend: `Golang`
|
||||
- Database: `PostgreSQL`
|
||||
- Deployment: `Docker`
|
||||
|
||||
## Backend
|
||||
|
||||
### Structure example (TODO: Replace with actual one)
|
||||
|
||||
```sh
|
||||
backend/
|
||||
├── main.go # Entry point
|
||||
├── api/ # Route handlers grouped by domain
|
||||
│ ├── auth.go
|
||||
│ └── coverletters.go
|
||||
├── routes/ # HTTP route registration
|
||||
│ └── routes.go
|
||||
├── middleware/ # Custom middleware (logging, auth)
|
||||
│ └── auth.go
|
||||
├── models/ # Data models, structs, db access
|
||||
│ ├── user.go
|
||||
│ └── coverletter.go
|
||||
├── services/ # Business logic (e.g. OpenAI integration)
|
||||
│ ├── auth_service.go
|
||||
│ └── coverletter_service.go
|
||||
├── utils/ # Shared helpers/utilities
|
||||
│ └── jwt.go
|
||||
└── config/ # Env loading, settings
|
||||
└── config.go
|
||||
|
||||
```
|
||||
|
||||
## Frontend
|
||||
|
||||
### Structure example
|
||||
|
||||
TODO: ADD STRUCTURE EXAMPLE
|
||||
|
||||
## Deployement
|
||||
|
||||
TODO: ADD DEPLOYMENT INSTRUCTIONS
|
||||
|
||||
## Development
|
||||
|
||||
TODO: ADD DEV INSTRUCTIONS
|
||||
Reference in New Issue
Block a user