Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yann39/ccteam-graphql
Spring Boot application to expose data through GraphQL for the CCTeam mobile application
https://github.com/yann39/ccteam-graphql
graphql java jpa mariadb spring-boot
Last synced: 13 days ago
JSON representation
Spring Boot application to expose data through GraphQL for the CCTeam mobile application
- Host: GitHub
- URL: https://github.com/yann39/ccteam-graphql
- Owner: Yann39
- License: gpl-3.0
- Created: 2024-03-17T17:06:59.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-11-06T22:03:48.000Z (3 months ago)
- Last Synced: 2025-01-16T10:19:27.733Z (20 days ago)
- Topics: graphql, java, jpa, mariadb, spring-boot
- Language: Java
- Homepage:
- Size: 299 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CCTeam GraphQL
**Spring Boot** application to expose **GraphQL** endpoint for **CCTeam** mobile application.
---
# Table of Contents
* [About](#about)
* [Installation](#installation)
* [Usage](#usage)
* [License](#license)
# About
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](https://https://github.com/Yann39/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 **JWT**s
- **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
# Installation
To run the application locally :
1. Start a **MariaDB** instance on port `3306` :
```bash
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 :
```sql
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) :
```properties
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) :
```properties
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 :
```bash
java -jar -Dspring.profiles.active=local ccteam-graphql.jar
```
# Usage
You can run the tests using :
```bash
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.
# Documentation
User roles :
- NORMAL : default user role, not member of the team
- MEMBER : members that have been accepted in the team
- ADMIN : administrator users
# License
[General Public License (GPL) v3](https://www.gnu.org/licenses/gpl-3.0.en.html)
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 .