/spring-rest-api-starter

A "simple" starter project custom RESTful API using Spring.

Primary LanguageJavaGNU Affero General Public License v3.0AGPL-3.0

README

Build Status codecov

What is this repository for?

A "simple" starter project custom RESTful API.

The project uses Spring Boot and a MySQL database.

Prerequisites

  1. Globally installed Git, JDK (8 at least), Maven and MySQL

Installation

  • git clone https://github.com/monogramm/spring-rest-api-starter.git
  • cd spring-rest-api-starter
  • mysql --user=root --password < src/main/resources/_schema-mysql.sql
  • mysql --user=root --password < src/main/resources/_data-mysql.sql

Finally, edit the properties in application.properties to your needs (name, db, mail, etc...).

Run Backend API

  • mvn spring-boot:run

Tests

Unit Tests

  • mvn test

Integration Tests

  • mvn verify

Be careful as the IT will startup the server and test the actual functions. This means that all application properties are valid for integration, even mail ones (not mocked).

Contribution guidelines

See CONTRIBUTING file.

License

This product is distributed under the GNU Affero General Public License v3.0. See the complete license in the bundle:

Read the license

Who do I talk to?