cc-franchise

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

JDK 17

Docker

How to run

Before run the application , we should set up the container for pgAdmin and Postgresql by running the following command

docker-compose up

How to access pgAdmin page

Open localhost:{PORT} in browser (default port 8002). You can customise the {PORT} in docker-compose.yml, line 24 as following:

ports:
    - <PORT>:80

Use default email: [email protected] and password: admin to login. You can customise the email and password in docker-compose.yml, line 26 as following:

environment:
      PGADMIN_DEFAULT_EMAIL: {EMAIL}
      PGADMIN_DEFAULT_PASSWORD: {PASSWORD}

create a new server by entering postgresql in host name/address area, username postgres and password admin. You can customise email and password in docker-compose.yml.

environment:
      - POSTGRES_DB=postgres
      - POSTGRES_USER={username}
      - POSTGRES_PASSWORD={password}

Running the tests

Run the automated tests for this system by following:

Gradle -> Tasks -> verification -> test

or use cli in terminal using following:

./gradlew test