Skip to content
Franchise management system REST API built with Java and Spring Boot
Java
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
LICENSE
README.md
mvnw
mvnw.cmd
pom.xml

README.md

Clinker

Clinker is a franchise management service backed by a REST API built with Java and Spring Boot.

Features:

  • manage franchisor and franchisee data
  • invoice and payment system
  • generate and track franchise fees (ex. royalties and marketing fees based on total sales)
  • record sales and expenses and generate financial metrics

Setup Locally

Requirements

  • Java 9 or later
  • Maven

Installation

 git clone https://github.com/xiao-vincent/clinker.git
 cd clinker 

Database Configuration

This application currently uses PostgreSQL. To use a different database, change the settings defined in the application.properties file. For more information, checkout Spring's documentation on how to work with databases.

Run the server on localhost:8080 with

./mvnw spring-boot:run

or use your IDE's build/run tool

Test Connection

Test the api with

curl -i localhost:8080/api/ping

and you should get response

HTTP/1.1 200 OK

Built With

  • Spring - Web Framework
    • Spring Boot - preconfiguration
    • Spring Data JPA - JPA data access abstraction
    • Spring Security - authentication and access-control framework
  • PostgreSQL - Relational Database
  • Maven - Dependency Management
You can’t perform that action at this time.