https://github.com/bachiriy/melodyguard

https://github.com/bachiriy/melodyguard

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bachiriy/melodyguard
• Owner: bachiriy
• Created: 2024-12-09T15:27:15.000Z (28 days ago)
• Default Branch: main
• Last Pushed: 2024-12-17T10:37:22.000Z (20 days ago)
• Last Synced: 2024-12-17T11:32:47.458Z (20 days ago)
• Language: Java
• Size: 42 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MelodyGuard API

## Project Overview

A secure REST API for managing a music catalog with JWT authentication and role-based access control, developed using Spring Boot.

## Technologies

- Spring Boot

- Spring Security

- JWT Authentication

- MongoDB (NoSQL database)

- Jenkins (CI/CD)

- Docker

## Key Features

- Album Management

- Song Management

- User Authentication

- Role-Based Access Control

  - USER role: Read operations

  - ADMIN role: Full CRUD operations

## Authentication

- Stateless JWT authentication

- Secure password encryption

- Role-based access to endpoints

## Setup and Installation

1. Clone the repository

2. Configure application properties

3. Build with Maven

4. Run Docker container

## Endpoints

- `/api/auth/login`: Authentication

- `/api/auth/register`: User registration

- `/api/user/albums`: User album operations

- `/api/admin/albums`: Admin album operations

## Development Environment

- Java 8

- Maven

- MongoDB

- Docker

- Jenkins

## Testing

- Unit Tests: JUnit

- Integration Tests: Mockito

- API Testing: Postman

## Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

---