thiagoolsilva / goal_api

This is the Goal Rest API project that intends to help persons to reach their goals using Spring Boot with Kotlin as technology support.

Goal API

This is the Goal API project that intend to help person to reach goals.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This project aims to help developers to create application that helps a person to reach their goals and to develope it It was used spring boot, JPA, Hibernate, Kotlin using clean architecture.

Built With

To build the project you should have gradle installed.

Getting Started

This is an example of how you may give instructions oTo build this project you should go to source folder and type the following commands make build and make start.

Prerequisites

Gradle

Installation

1. Get the latest code on repository
2. Go to source folder and build the project as described in Getting Started section
3. Create your application using the API

Swagger

1. Build and start the project as described in section Prerequisites
2. Go to http://localhost:8080/swagger-ui.html#/

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache V2 License. See LICENSE for more information.

Contact

Thiago Lopes da Silva - @thiagoolsilva - [e-mail]

Project Link: https://github.com/thiagoolsilva/goal_api