TaskManagerAPI

Overview

TaskManagerAPI is a backend application built using Go (Golang) to manage users, projects, and tasks. The API is designed to handle typical operations like creating, updating, deleting, and retrieving data for users, projects, and tasks. It uses PostgreSQL as the database and GORM as the ORM.

Features

• User Management: Create, retrieve, update, and delete users.
• Project Management: Create, retrieve, update, and delete projects.
• Task Management: Create, retrieve, update, and delete tasks.
• Relational Data: Projects belong to users, and tasks belong to projects.

Requirements

• Go: Version 1.20 or higher
• Docker: For containerized PostgreSQL and application
• Make: To streamline project commands

Installation

1. Clone the repository:

   git clone https://github.com/talyx/TaskManagerApi.git
   cd TaskManagerApi

2. Start PostgreSQL using Docker:

   make up

   This will run PostgreSQL in a Docker container.

3. Install dependencies:

   go mod tidy

4. Start the application in debug mode:

   make run-debug

5. Start the application in production mode:

   make run-production

   The server will run on http://localhost:8005 by default.

Makefile Commands

• make up: Start PostgreSQL in a Docker container
• make down: Stop and remove PostgreSQL container
• make psql: To connect to a container with PostgreSQL and start an interactive psql session
• make status: To check the status of a database container
• make reset-db:: To reset database container
• make run-debug: Run the application in debug mode
• make run-production: Run the application in production mode

API Endpoints

Below are the available API endpoints for managing Users, Projects, and Tasks.

---

User Endpoints

Method	Endpoint	Description	Request Body
POST	/register	Create a new user	{ "names": "John Doe", "email": "john.doe@example.com", "passwordhash": "securepassword"}
GET	/users	Retrieve all users
GET	/user/{id}	Retrieve a user by ID
PUT	/user/{id}	Update a user by ID	{ "names": "Jane Doe", "email": "jane.doe@example.com", "passwordhash": "newpassword"}
DELETE	/user/{id}	Delete a user by ID

Note: When creating a user, the passwordhash field should contain a securely hashed password.

---

Project Endpoints

Method	Endpoint	Description	Request Body
POST	/project	Create a new project	{ "name": "Project Alpha", "description": "This is the first project."}
GET	/projects	Retrieve all projects
GET	/project/{id}	Retrieve a project by ID
PUT	/project/{id}	Update a project by ID	{ "name": "Project Beta", "description": "Updated project description."}
DELETE	/project/{id}	Delete a project by ID

Note: The UserID is automatically associated with the authenticated user when creating a project.

---

Task Endpoints

Method	Endpoint	Description	Request Body
POST	/task	Create a new task	{ "title": "Task One", "description": "This is the first task.", "ProjectID": 1}
GET	/tasks	Retrieve all tasks
GET	/task/{id}	Retrieve a task by ID
PUT	/task/{id}	Update a task by ID	{ "name": "Task Two", "description": "Updated task description."}
DELETE	/task/{id}	Delete a task by ID

Note: The ProjectID field is used to associate the task with a specific project.

---

Authentication

• Authentication: Most endpoints require authentication. Use the /login endpoint to obtain a session or token.
• Authorization: Ensure that the authenticated user has the necessary permissions to perform actions on resources.

Example curl Requests

Create a User

curl -X POST http://localhost:8005/register \
-H "Content-Type: application/json" \
-d '{ "names": "John Doe", "email": "john.doe@example.com", "passwordhash": "securepassword"}'

Authorization by a created user

curl -v -X POST http://localhost:8005/login \
-H "Content-type: application/json" \
-d '{"login":"john.doe@example.com", "password":"securepassword"}' \
-c cookies.txt

Get All Users

curl -X GET http://localhost:8005/users -b cookies.txt

Create a Project

curl -X POST http://localhost:8005/project \
-H "Content-Type: application/json" \
-d '{ "name": "Project Alpha", "description": "This is the first project."}' \
-b cookies.txt

Get All Projects

curl -X GET http://localhost:8005/projects -b cookies.txt

Create a Task

curl -X POST http://localhost:8005/task \
-H "Content-Type: application/json" \
-d '{ "title": "Task One", "description": "This is the first task.", "ProjectID": 1}' \
-b cookies.txt

Get All Tasks by project

curl -X GET http://localhost:8005/tasks/1 -b cookies.txt