Skip to content

tainajmedeiros-zz/ErrorCenter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Error Center

REST API developed to monitor an error center.s!

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contact

About The Project

This API allows developers to centralize all error logs in one place, where they can monitor and make better decisions. In this project, we will implement a system to centralize application error records.

[Swagger Screen Shot]

The project architecture is formed by:

  • Access endpoints that can be used by a front application
  • Endpoints that will be used to write error logs to a relational database
  • The API allows access only with a valid authentication token

😄

Created With

The project was created using the following conditions:

  • [Java 8 or more]
  • [Postgres]

Getting Started

Follows instructions for running the API.

Installation

  1. Clone the repo
    git clone https://github.com/tainajmedeiros/ErrorCenter.git
  2. Show this help
    make help
  3. Show Makefile
    make default
  4. Build the .jar package
    make package-java
  5. Run all project test
    make tests
  6. Create the Error Center image
    make build-docker-image
  7. Builds, (re)creates, starts, and attaches to containers for a service
    make run

If you need, see and execute all commands with

make up

If you need, see the commands:

make

[Make Screen Shot]

Usage

You have access to authentication endpoints, logs and users

Auth Endpoints [Swagger auth Screen Shot]

Log Endpoints [Swagger log Screen Shot]

User Endpoints [Swagger user Screen Shot]

Contact

Tainá Medeiros - @taina_medeiros - tainajmedeiros@gmail.com

LinkedIn: /tainamedeiros

Project Link: https://github.com/tainajmedeiros/ErrorCenter

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages