/CRMS

Clubroom Reservation Management System

Primary LanguageJavaMIT LicenseMIT

CRMS - Clubroom Reservation Management System

build test code check deploy Version 1.0 MIT License

This app is a clubroom reservation management system.

Develop

Requirements

  • Java OpenJDK 11
  • Spring Boot 2.5
  • Angular 12
  • MySQL 8.0

Usage

If you want to run on Windows, you can use gradlew.bat instead of of gradlew.

How to bulid

$ ./gradlew build -x test

When build successful, you can find .jar file in app/build/libs

How to run

First, you need to launch mysql with docker-compose.

$ docker-compose up -d

Then you can launch application. Default port is 8080. If you want to change port, run with -Dserver.port=XXXX.

# 1. run .jar file
$ java -jar crms-<version>.jar  # -Dspring.profiles.active=<environment>

# 2. run on dev environment
$ ./gradlew bootRun

How to test

# 1. all tests
$ ./gradlew test

# 2. only unit tests
$ ./gradlew unitTest

# 3. only integration tests
$ ./gradlew integrationTest

API docs

This project support Swagger UI.

  1. Run application
  2. Access to Swagger UI

Wiki

You can find more details on wiki.