kikiodazie/teamwork-api

Teamwork is an internal social network API for employees of an organization. The goal of this API is to facilitate more interaction between colleagues and promote team bonding.

Teamwork-API

Backend REST API for TeamWork App.

Introduction

Teamwork is a side project I developed for learning purposes.The idea is to model an internal social network for employees of an organization. The goal of this API is to facilitate more interaction between colleagues and promote team bonding(In this time of COVID-19 this may be useful for coping with the new way of working).

This is backend API was built with Java/Spring-Boot & Postgres,documented with Swagger, deployed on heroku. View Docs.

Features

While not having 100% code coverage. I implemented the core ideal features.

• Email and password authentication
• Admin can create an employee user account.
• Admin/Employees can sign in.
• Employees can post gifs.
• Employees can write and post articles.
• Employees can edit their articles.
• Employees can delete their articles.
• Employees can delete their gifs post.
• Employees can comment on other colleagues' article post.
• Employees can comment on other colleagues' gif post.
• Employees can view all articles and gifs, showing the most recently posted articles or gifs first.
• Employees can view a specific article.
• Employees can view a specific gif post.

See DOCS for working endpoints

Development

Java 11, Spring Boot 2.4, Maven, Postgres, Swagger, Git, Travis CI, Heroku

teamwork-api's Issues

Can't seem to implement code coverage with coveralls

Unit test for controllers endpoints

Wahala for no sabi write unit test for secured endpoints oooo because OT hard.

Currently the is a Bug for the API Response Specification on this swagger docs.