Skip to content

Syn4z/Cash-Flow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cash flow

money

A tool that let's you track your expenses, income, transfers and much more. It is an application for everything you can do with your money. This project includes a NestJS server for backend operations, a Flutter application for cross-platform mobile development, and uses Prisma for database access.

Technologies Used

  • Backend: NestJS
  • Database: Prisma with PostgreSQL
  • Mobile Development: Flutter

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

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

  • Node.js (v16 or above)
  • Docker (for database and containerization)
  • Flutter SDK (for mobile development)

Installing

A step by step series of examples that tell you how to get a development environment running.

Server Setup

  1. Navigate to the server directory:
cd nest_server/nest-app
  1. Install the dependencies:
npm install
  1. Set up your .env file based on the .env.example provided in the nest_server/nest-app directory. Make sure to replace the placeholder values with your actual database credentials and secrets.

  2. Build the server:

npm run build
  1. Start the server:
npm run start:prod

Docker Setup

To containerize your application, ensure Docker is installed and running on your machine. Then, execute the following commands:

cd nest_server/nest-app
docker-compose up --build

This will build the Docker image for your server and start the containers as defined in your docker-compose.yml and Dockerfile.

Mobile App Setup

Refer to the cash_flow directory for mobile app development. Ensure you have Flutter installed and set up correctly.

  1. Navigate to the Flutter app directory:
cd cash_flow
  1. Get Flutter dependencies:
flutter pub get
  1. Run the app on your device or emulator:
flutter run

Contributors

About

University project made by 6 students at TUM

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •