TaskGuard Management API

A comprehensive RESTful API for task and project management with authentication and role-based access control.

🚀 Features

User Management: Registration, authentication, and profile management
Project Management: Create, update, and manage projects with team collaboration
Task Management: Comprehensive task tracking with priorities, due dates, and assignments
Role-Based Access Control: Admin, Manager, and User roles with appropriate permissions
JWT Authentication: Secure token-based authentication
RESTful API: Clean, well-documented REST endpoints
Database Support: H2 (development) and MySQL (production) support
API Documentation: Interactive Swagger UI documentation
Comprehensive Testing: Unit tests, integration tests, and API testing scripts

🏃 Quick Start

Prerequisites

Java 17 or higher
Maven 3.9+
MySQL 8.0+ (optional, H2 included for development)

Installation

Clone the repository

git clone https://github.com/naldmach/taskguard-api.git
cd taskguard-api

Build the project
```
mvn clean install
```
Run the application
```
mvn spring-boot:run
```
Access the application
- API Base URL: http://localhost:8080/api
- Swagger UI: http://localhost:8080/api/swagger-ui.html
- H2 Console: http://localhost:8080/api/h2-console

Quick Test

# Check if the API is running
curl http://localhost:8080/api/test/health

# Register a new user
curl -X POST http://localhost:8080/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "testuser",
    "email": "[email protected]",
    "password": "password123",
    "firstName": "Test",
    "lastName": "User"
  }'

🔌 API Endpoints

Authentication

POST /auth/register - Register a new user
POST /auth/login - Login and get JWT token

Users

GET /users - Get all users (Admin only)
GET /users/{id} - Get user by ID
PUT /users/{id} - Update user profile
DELETE /users/{id} - Deactivate user

Projects

GET /projects - Get user's projects
POST /projects - Create new project
GET /projects/{id} - Get project by ID
PUT /projects/{id} - Update project
DELETE /projects/{id} - Delete project
POST /projects/{id}/members/{userId} - Add member to project
DELETE /projects/{id}/members/{userId} - Remove member from project

Tasks

GET /tasks - Get user's tasks
POST /tasks - Create new task
GET /tasks/{id} - Get task by ID
PUT /tasks/{id} - Update task
DELETE /tasks/{id} - Delete task
GET /tasks/project/{projectId} - Get tasks by project

System

GET /test/health - Health check endpoint
GET /test/info - Application information

🔐 Authentication

The API uses JWT (JSON Web Tokens) for authentication. After successful login, include the token in the Authorization header:

Authorization: Bearer <your-jwt-token>

Example Authentication Flow

Register a user

curl -X POST http://localhost:8080/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "johndoe",
    "email": "[email protected]",
    "password": "securepassword",
    "firstName": "John",
    "lastName": "Doe"
  }'

Login to get token

curl -X POST http://localhost:8080/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "johndoe",
    "password": "securepassword"
  }'

Use token for authenticated requests

curl -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  http://localhost:8080/api/projects

🗄️ Database Configuration

H2 Database (Development - Default)

The application uses H2 in-memory database by default for easy development:

spring:
  datasource:
    url: jdbc:h2:mem:testdb
    username: sa
    password: 
    driver-class-name: org.h2.Driver

H2 Console: http://localhost:8080/api/h2-console

JDBC URL: jdbc:h2:mem:testdb
Username: sa
Password: (leave empty)

MySQL Database (Production)

To use MySQL, update application.yml:

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/taskguard?useSSL=false&serverTimezone=UTC&allowPublicKeyRetrieval=true
    username: your_username
    password: your_password
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    properties:
      hibernate:
        dialect: org.hibernate.dialect.MySQLDialect

🧪 Testing

Quick Test Script

Run the comprehensive test script:

./test-api.sh

Manual Testing

# Unit tests
mvn test

# Integration tests
mvn verify

# Build and test
mvn clean install

Testing with Postman/Insomnia

Import the API collection or use the Swagger UI for interactive testing.

For detailed testing instructions, see TESTING.md.

📚 API Documentation

Swagger UI

Interactive API documentation is available at: http://localhost:8080/api/swagger-ui.html

Features:

Try out API endpoints directly
View request/response schemas
Test authentication flows
Download OpenAPI specification

OpenAPI Specification

Raw OpenAPI spec available at: http://localhost:8080/api/api-docs

🛠️ Development

Project Structure

src/
├── main/
│   ├── java/com/taskguard/
│   │   ├── config/          # Configuration classes
│   │   ├── controller/      # REST controllers
│   │   ├── dto/            # Data Transfer Objects
│   │   ├── entity/         # JPA entities
│   │   ├── repository/     # Data repositories
│   │   ├── security/       # Security configuration
│   │   └── service/        # Business logic services
│   └── resources/
│       ├── application.yml # Configuration
│       └── application-test.yml
└── test/                   # Test classes

Key Technologies

Spring Boot 3.2.0 - Application framework
Spring Security 6.2.0 - Authentication and authorization
Spring Data JPA - Data persistence
JWT (JJWT 0.12.3) - Token-based authentication
H2/MySQL - Database support
Swagger/OpenAPI 3 - API documentation
Maven - Build and dependency management

Development Setup

IDE Setup
- Import as Maven project
- Configure Java 17
- Enable annotation processing

Environment Configuration

# Copy and modify configuration
cp src/main/resources/application.yml src/main/resources/application-dev.yml

Database Setup

# For MySQL (optional)
mysql -u root -p
CREATE DATABASE taskguard;

Code Quality

Linting: All code follows Java conventions
Testing: Comprehensive unit and integration tests
Security: JWT-based authentication with role-based access control
Documentation: Swagger/OpenAPI documentation

🔧 Configuration

Application Properties

Key configuration options in application.yml:

# Server configuration
server:
  port: 8080
  servlet:
    context-path: /api

# JWT configuration
jwt:
  secret: your-secret-key-here-make-it-very-long-and-secure-in-production
  expiration: 86400000 # 24 hours

# Database configuration
spring:
  datasource:
    url: jdbc:h2:mem:testdb
    username: sa
    password: 
  
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true

Environment Variables

For production, use environment variables:

export JWT_SECRET=your-very-secure-secret-key
export DB_URL=jdbc:mysql://localhost:3306/taskguard
export DB_USERNAME=taskguard_user
export DB_PASSWORD=secure_password

🚀 Deployment

Docker (Coming Soon)

# Build image
docker build -t taskguard-api .

# Run container
docker run -p 8080:8080 taskguard-api

Production Checklist

🤝 Contributing

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Development Guidelines

Follow Java coding conventions
Write comprehensive tests
Update documentation
Ensure all tests pass
Follow RESTful API design principles

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

📞 Support

Issues: GitHub Issues
Documentation: Wiki
API Reference: http://localhost:8080/api/swagger-ui.html

🎯 Roadmap

Made with ❤️ using Spring Boot

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
src		src
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
TESTING.md		TESTING.md
docker-compose.yml		docker-compose.yml
init.sql		init.sql
pom.xml		pom.xml
test-api.sh		test-api.sh

naldmach/taskguard-api

Folders and files

Latest commit

History

Repository files navigation