https://github.com/kfeuerschvenger/task-manager-api
RESTful API designed to manage tasks in a collaborative environment
https://github.com/kfeuerschvenger/task-manager-api
go postgres rest-api
Last synced: about 2 months ago
JSON representation
RESTful API designed to manage tasks in a collaborative environment
- Host: GitHub
- URL: https://github.com/kfeuerschvenger/task-manager-api
- Owner: kfeuerschvenger
- License: mit
- Created: 2025-05-28T06:59:33.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-28T07:17:38.000Z (about 1 year ago)
- Last Synced: 2025-08-10T14:23:59.337Z (11 months ago)
- Topics: go, postgres, rest-api
- Language: Go
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Collaborative Task Management API
This project is a RESTful API designed to manage tasks in a collaborative environment. Built with Go and PostgreSQL, it follows clean architecture principles and is fully containerized with Docker.
## Technologies Used
| Backend | Database | DevOps | Tools |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
| 
| 
| 
|
## Features
- User registration and login with JWT authentication.
- Task management with creation, update, and filtering.
- Tasks can be created for oneself or assigned to other users.
- Protected routes requiring authentication.
- PostgreSQL database with migrations.
- Dockerized environment for easy setup.
## Project Structure
```
task-manager-api
├── cmd
│ └── main.go
├── controllers
│ ├── auth_controller.go
│ ├── healthcheck_controller.go
│ └── task_controller.go
├── database
│ ├── db.go
│ ├── migrations
│ │ ├── 000001_enable_uuid_ossp.down.sql
│ │ ├── 000001_enable_uuid_ossp.up.sql
│ │ ├── 000002_create_users_table.down.sql
│ │ ├── 000002_create_users_table.up.sql
│ │ ├── 000003_create_tasks_table.down.sql
│ │ └── 000003_create_tasks_table.up.sql
│ └── migrations.go
├── docs
│ ├── docs.go
│ ├── swagger.json
│ └── swagger.yaml
├── dto
│ ├── auth.go
│ ├── error.go
│ └── task.go
├── errors
│ ├── auth.go
│ ├── errors.go
│ └── validation.go
├── middleware
│ └── auth.go
├── models
│ ├── task.go
│ └── user.go
├── routes
│ └── routes.go
├── services
│ ├── auth_service.go
│ └── task_service.go
├── tests
│ ├── auth_test.go
│ ├── task_test.go
│ └── utils_test.go
├── utils
│ ├── bcrypt.go
│ ├── email.go
│ ├── jwt.go
│ └── response.go
├── validators
│ └── auth.go
├── .env
├── .env.example
├── .gitignore
├── docker-compose-test.yml
├── docker-compose.yml
├── Dockerfile
├── go.mod
├── go.sum
└── README.md
```
## Setup Instructions
1. Copy the example environment variables file:
```sh
cp .env.example .env
```
2. Build and run all services using Docker Compose:
```sh
docker-compose up -d --build
```
3. The API will be available at `http://localhost:8080` (or the configured port).
4. Database migrations will run automatically on startup.
## Runing Tests
To run the unit and integration tests, use the following command:
```sh
docker compose -f docker-compose-test.yml up --abort-on-container-exit test
```
make sure the .env file is properly configured for the test environment.
## API Endpoints
### Authentication
- **Register:** `POST /auth/register`
- **Login:** `POST /auth/login`
### Task Management (requires authentication)
- **Create Task:** `POST /tasks`
- **List Tasks:** `GET /tasks?status=&priority=`
- **Get one Task:** `GET /tasks/:id`
- **Update Task:** `PUT /tasks/:id`
- **Delete Task:** `DELETE /tasks/:id`
### Documentation
- **Navigate to:** `http://localhost:8080/documentation/index.html`
### Health Check
- **Ping:** `GET /ping`
## Environment Variables
See `.env.example` for the list of required environment variables.
## Notes
- Only the task creator can update a task.
- Passwords are securely stored using bcrypt.
- JWT tokens are required for all protected routes.