FFM Application

Powered by ChromaCorps

Table of Contents

• Project Overview
• Technologies
• Installation Instructions
• Running the Application
  • Setting Up and Running Flask
  • Starting the React Native Frontend
• Deployment
• Testing

Project Overview

FFM (Family Financial Management) Application is a full-stack application built with a Flask Backend following the FlaskMVC pattern and React Native Frontend. This app aims to provide users with a seamless way to track and manage their financial transactions, budgets and goals.

Technologies

• Backend: Python 3, Flask
• Frontend: React Native
• Database: PostgreSQL
• Backend Deployment: Render
• Frontend Deployment: Expo

Installation Instructions

To get started with this project locally, follow these steps to install the required dependencies.

1. Clone the Repository

Clone the repository to your local machine:

$ git clone https://github.com/Chroma-Corps/FFM-Application.git
$ cd FFM-Application

2. Installing Backend Dependencies

Make sure you have Python 3 and pip installed. Then, install the Python dependencies:

$ pip install -r requirements.txt

3. Installing Frontend Dependencies

Ensure you have Node.js installed. Install Expo CLI globally if you haven't already:

$ npm install -g expo-cli

Navigate to the React folder and install the necessary dependencies:

$ cd React
$ npm install

Running the Application

Setting Up and Running Flask

Start by setting up the backend. First, initialize the Flask application with the following command:

$ flask init

This will set up the necessary configurations, such as database migrations. Next, start the Flask development server:

$ flask run

The Flask backend will now be running locally.

Starting the React Native Frontend

Once the Flask backend is running, open another terminal and navigate to the React folder:

$ cd React

Now, launch the React Native development server with:

$ npx expo start

Open in browser or scan the QR Code using 📲 Expo Go

Deployment

You can easily deploy the project to Gitpod or Render:

To view the app on your mobile device:

• STEP 01: Install the Expo Go application 📲 Expo Go - Apps on Google Play Or search for "Expo Go" in the App Store or Google Play.

• STEP 02: Scan the QR Code using Expo Go Once the Metro bundler is running (from npx expo start), scan the displayed QR code with Expo Go to instantly preview the app on your device.

• Here Is Our Deployed Version

Testing

Unit & Integration Testing

You can then execute all unit tests as follows

$ flask test all unit

You can then execute all user tests as follows

$ flask test user

💡 You can also supply "unit" or "int" at the end of the command to execute only unit or integration tests.

You can also run all application tests with the following command

$ pytest