TypeTask-Pro's Official API

This project has been created to be TypeTask Pro's official API!

It's been developed with the intention to learn more about Spring Boot Web using
the latest features.

This project was built in Java, Java Spring, PostgreSQL and JWT for authentication.

Docs Summary

• Installation Guide
• Starting the Application
• Endpoints
• Roles
• Database
• Contributing

Installation Guide

1. Clone this repo with:

git clone git@github.com:MartinGHaas/TypeTaskPro-Backend.git

2. Install Maven dependencies
3. Install PostgreSQL
4. Change application.yml to your own Settings

Starting the Application

1. Start the Application
2. Access the API locally at localhost:8080
3. If everything runs correctly. You should've been redirected here!

Endpoints

Provided endpoints until now:

GET / - Redirects to README.md on GitHub

POST /auth/register - Register a new user into the App

POST /auth/login - Login as a user into the App

GET /users - Provides all users

GET /users/{id} - Provides the user with the Id

PUT /users/{id} - Updates the user with the Id

GET /projects/?userId={long} - Gets the user projects or all projects

POST /projects - Creates a new project

DELETE /projects/{id} - Deletes a project

PUT /projects/{id} - Updates a project

Authentication Roles

Roles until now:

USER - Default user role (low level of hierarchy)
ADMIN - Admin role in the application (high level of hierarchy)

Database

This project uses PostgreSQL as database!
Before running this application, make sure to change application.yml on .\src\main\resources\application.yml
to configure your own Postgres data (username & password & host & port).

Contributing

You are free to contribute to this project!

If you find any problems or want to suggest a new feature you
can open a Pull Request with a short explanation of your changes.