Spring Boot application to expose GraphQL endpoint for CCTeam mobile application.

• About
• Installation
• Usage
• License

This project holds the GraphQL APIs that expose data to be consumed by the CCTeam mobile application which is an application for managing a motorbike racing club (members, tracks, events, etc.).

See the ccteam-flutter repository for more information about the mobile application.

The application uses only a few starters and libraries :

• Spring Boot Data JPA starter as ORM
• Spring Boot GraphQL starter to expose data via GraphQL
• Spring Boot Security starter and Auth0 Java JWT library to handle security through JWTs
• Lombok library to avoid boilerplate code
• MariaDB client to connect to the database
• Jacoco / Surefire / Failsafe Maven plugins to handle tests and code coverage
• Thymeleaf to generate HTML form for the account deletion request

To run the application locally :

1. Start a MariaDB instance on port 3306 :

   docker run \
   --name mariadb-ccteam \
   --restart on-failure \
   -p 3306:3306 \
   -e MARIADB_DATABASE=ccteam \
   -e MARIADB_ROOT_PASSWORD=rootpasswordhere \
   -e MARIADB_USER=ccteam \
   -e MARIADB_PASSWORD=userpasswordhere \
   -d docker.io/library/mariadb:10.5
   --character-set-server=utf8mb4 \
   --collation-server=utf8mb4_unicode_ci

   It should create a database ccteam and a user ccteam.

   Change the password and make sure to use the same values in your local properties configuration (you can create a new application-local.properties file to override default properties ) for database connection string.

   If you already have a running MariaDB server, then you can create the database as follows :

   CREATE DATABASE ccteam CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

2. If you want JPA to create the database structure, set the following properties (in your application-local.properties file) :

   spring.jpa.hibernate.ddl-auto=                      update

   And if you want to initialize the database with some default data, set the following properties (in your application-local.properties file) :

   spring.sql.init.mode=                               always
   spring.jpa.defer-datasource-initialization=         true

   This will run the src/main/resources/data.sql file to insert the data. The default password for every user is 123456.

3. Run the application with the right profile :

   Simple run the JAR file either from your IDE, or using the following command :

   java -jar -Dspring.profiles.active=local ccteam-graphql.jar

You can run the tests using :

mvn clean test

This will also generate an HTML coverage reports thanks to the Jacoco Maven plugin (along with the Surefire and Failsafe Maven plugins). You will find it under target\site\jacoco\index.html

The authentication/registration related endpoints are exposed via REST. You can test either the GraphQL or the REST endpoints using command line (i.e. using cURL), or we provide a ready-to-use Insomnia export in the src/main/resources directory.

User roles :

• NORMAL : default user role, not member of the team
• MEMBER : members that have been accepted in the team
• ADMIN : administrator users

General Public License (GPL) v3

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.