big-d0g/cfg-project

Final project from CodeFirstGirls Software Dev Nanodegree (September 2022)

Code First Girls Peer To Peer Project

---

Team Members

Becca Starr

Ingrid Kovacs

Karina Golovlova

Nelli Zsoldos

Sheryl Leslie

Project Management

We used jira to track our work. Our project is here.

We also kept a project criteria tracker here.

Overview

Summary

We have created a basic peer-to-peer community lending application called 'Lendr'. It enables a user to sign up with an account, and request to lend or borrow a sum of money with a desired interest rate.

The request generates an 'order'. If a "lend" order corresponds with one or more "borrow" orders, they are matched andd a "contract" is created between the users who have placed an order. A user can view their orders and contracts on their personal account page. They can also delete any unmatched orders from this page.

Additionally, the user can view the current status of the "Fear and Greed Index", which is a tool created by CNN Money based on the assertion that the stock market is driven by those emotional states. The intent is to demonstrate that people should avoid organising loans with their banking institutions and instead manage loans via community lending.

Framework

The application is based on the Flask framework with some extension modules, including:

• Flask-SQL Alchemy to enable better integration with the SQLAlchemy database toolkit
• Flask-Login and Werkzeug security modules for user authentication and password hashing
w, either click the link in your terminal, or open your browser and go to http://localhost:5000. Please note that the appli
• Several SQLAlchemy extensions including sqalchemy-orm for Object Relational Mapping, sqlalchemy-utils providing assorted utility functions, and mock-alchemy to assist with the accompanying test suite.

External API

The integration for the external API has been built using the following:

• The Fear and Greed Index API from the RapidAPI marketplace.
• The plotly module as the visualisation tool.

Testing

A suite of unit tests has been created and the files are stored in the /tests folder.

---

Running the Application

Local Set up

1. clone the project in PyCharm
2. follow the Pycharm prompts to create the virtual environment
3. run pip install -r requirements.txt from your terminal

Database

1. open db_config.py
2. replace the username and password with the ones you use for your local MySql database
3. you can now proceed with running the application

Local Running

From PyCharm:

open app.py and click run

From Terminal:

run python app.py

Accessing

The application should now be running on port 5000. To view, either click the link in your terminal, or open your browser and go to http://localhost:5000.

Please note that the application is best viewed in Google Chrome or any other chrome-based browser.