TeachMeSkills Final Project

💵 Cash Control Application

Table of Contents

1. About The Project
   • Main Technologies
2. Getting Started
   • Basic
   • Docker
   • Root credentials
3. Demo
   • Sign in
   • Sign up
   • Side menu
   • Admin board
   • Incomes
   • Expenses
   • Transfers
   • Helpful toasts
   • Reports (BETA)
4. Future updates

📄 About The Project

Full Stack web application to control the cash flow.

📝 Main Technologies

Database
Backend
Frontend
Security

---

⚙️ Getting Started

To get a local copy up and running follow these simple steps.

• Clone the repository

git clone https://github.com/IvanHayel/cash-control-application.git

• Create PostgreSQL database

CREATE DATABASE cash_control
    WITH 
    OWNER = postgres
    ENCODING = 'UTF8'
    LC_COLLATE = 'English_World.1252'
    LC_CTYPE = 'English_World.1252'
    TABLESPACE = pg_default
    CONNECTION LIMIT = -1;

Basic

Frontend

You can use npm or yarn.

1. Move to the cash-control-client folder and install dependencies

yarn install

2. Run the application

yarn run start

Backend

Java version 17+ is required.

1. Move to the cash-control-server folder and just run spring-boot application

mvn spring-boot:run

🐋 Docker

Application can be run in Docker container.

1. Package the application with Maven to jar file

mvn clean package

or with skipping tests

mvn clean package -DskipTests

2. Use docker-compose in root folder to run the application

docker-compose up

🔑 Root credentials

Username: root

Password: root3301

---

🪄 Demo

Sign in

Sign up

Side menu

Admin board

Wallets

Incomes

Expenses

Transfers

Helpful toasts

Reports BETA VERSION

---

💡 Future updates

• Full reports
• Code refactoring
• Test coverage
• Email notifications
• Heroku deployment