thiago-Malaca/cashback-test

   _____ _          __  __      _     _           
  / ____| |        / _|/ _|    | |   | |          
 | (___ | | ____ _| |_| |_ ___ | | __| | ___ _ __ 
  \___ \| |/ / _` |  _|  _/ _ \| |/ _` |/ _ \ '__|
  ____) |   < (_| | | | || (_) | | (_| |  __/ |   
 |_____/|_|\_\__,_|_| |_| \___/|_|\__,_|\___|_|   

       _                  
      | |                 
      | | __ ___   ____ _ 
  _   | |/ _` \ \ / / _` |
 | |__| | (_| |\ V / (_| |
  \____/ \__,_| \_/ \__,_|

This project was generated by Skaffolder

For more documentation visit https://skaffolder.com/#/documentation

PREREQUISITES

Apache Maven
JDK 1.7
PostgreSQL Database

CONFIGURE DATABASE

You can configure your database credentials in src/main/resources/config/dev.properties file. Your database will be automatically created by JPA when the Java application starts.

BUILD FRONTEND

If you are using Angular frontend type:

$ cd src/client
$ yarn install
$ yarn run build

If you want to keep updating frontend type:
```
$ yarn run watch
```

START APPLICATION

To start the application open a command line in the project's folder an type:
```
$ mvn spring-boot:run
```
This will start a lightweight Java server on your pc and run the application.
Go to http://localhost:8080

START WITH DOCKER

To start the application with Docker:
- Install Docker
- Change db URL in src/main/resources/config/dev.properties to: postgresql://database:27017
- Run command:
```
$ docker-compose up --build
```
- Go to http://localhost:80
When code changes you need to rebuild container running:
```
$ docker-compose up --build
```

SWAGGER API DOCS

You can find the swagger-ui page on: http://localhost:8080/swagger-ui.html

USING SKAFFOLDER-CLI

With Skaffolder-CLI you can easily manage your Skaffolder project from command line and customize your generator template from your IDE.

Install Skaffolder-CLI with

$ yarn install -g skaffolder-cli

$ sk login

Generate your project with the command

$ sk generate

You can customize your generator template working with files in .skaffolder folder in your project root.

Please refer to https://skaffolder.com/#/documentation/skaffolder-cli for more information.

thiago-Malaca / cashback-test