BoardroomManager API

A Rest API that helps you to manage boardrooms 🚀

📌 Table of Contents

• Features
• Requirements
• Installation
• Getting Started
• FAQ
• Found a bug? Missing a specific feature?
• Contributing
• License

🚀 Features

• CREATE
• READ
• UPDATE
• DELETE

Sample Valid JSON Request Body

Create -> /api/v1/boardrooms

[
  {
	"name": "Quebec",
	"date": "16/02/2021",
	"startHour": "09hs",
	"endHour": "12hs"
  }
]

It's important to mention that this is one of the applications from the BoardroomManager System

In order to explore the others, feel free to click on the link below:

• BoardroomManager WEB

Requirements

For building and running the application you need:

• JDK 8
• Maven

👷 Installation

To install this application, run the following commands:

git clone https://github.com/iamgrodrigues/boardroommanager-api.git

If you have a SSH key registered in your Github account, clone the project using this command:

git clone [email protected]:iamgrodrigues/boardroommanager-api.git

🏃 Getting Started

Running the application locally

There are several ways to run a Spring Boot application on your local machine. One way is to execute the main method in the com.iamgrodrigues.boardroommanagerapi.BoardroommanagerApiApplication class from your IDE.

Alternatively you can use the Spring Boot Maven plugin like so:

mvn spring-boot:run

After the above command, you can navigate to the following address to see the project up and runnig:

http://localhost:8082/api/v1/people

Status Codes

BoardroomManager returns the following status codes in its API:

Status Code	Description
200	OK
404	NOT FOUND
500	INTERNAL SERVER ERROR

📮 Faq

Question: What are the tecnologies used in this project?

Answer: The tecnologies used in this project are Java + Spring Boot.

🐛 Issues

Feel free to file a new issue with a respective title and description on the the boardroommanager API repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

Released in 2021. This project is under the MIT license.

Made with love by Guilherme Rodrigues 💚🚀