task-tracker

Task Tracker

Task management backend api project written in go.

Table of Contents

1. Project Overview
2. Features
3. Tech Stack
4. Architecture
5. Getting Started
   • Prerequisites
   • Installation
   • Running the Application
6. API Documentation
   • Authentication
   • Endpoints
7. Testing
8. Environment Variables
9. Contributing
10. License

Project Overview

Not yet written

Features

• Board based task management
• Shared task boards
• JWT based user authentication
• Dependency Injection
• Structured logging

Tech Stack

• Language: Go 1.25.3
• Web Framework: Gin v1.11.0
• Dependency Injection fx v1.24.0
• Database: MySQL
• ORM: GORM v1.31.1
• Logger: Zerolog v1.34.0
• Configuration: godotenv v1.5.1

Architecture

///Insert diagram or explanation of layers HTTP Handler --> Service Layer --> Repository / Database

• Handler: Handles HTTP requests and responses
• Service: Business logic
• Repository: Database operations

Getting Started

Prerequisites

• git: for cloning the repository
• Go: 1.25 or higher
• Database: MySQL (Can use other sql databases with minimal change)

Installation

1. Clone the repository and download dependencies

  git clone https://github.com/Nebuska/task-tracker.git
  cd task-tracker
  go mod download

2. Set up environments

• Create a .env file in the root directory using .env.example
• Adjust values according to your setup. See how

3. Set up database

• Create a database for the application (e.g., tasktracker)

Running the Application

With Makefile

Requires Unix Make

    choco install make

    make all

By default, the server should start on http://localhost:8080 (or the port you configured).

With Taskfile

Requires go-task

    go install github.com/go-task/task/v3/cmd/task@latest

    task run

With Docker

• Not implemented yet

Api Documentation

• Not finished documentation only short example
• Might use Swagger/OpenAPI later

Authentication

Endpoints

Testing

Environment Variables

Contributing

License