CS Capstone Project
An AI assisted budgeting and personal finance tool
Before cloning this repository, ensure you have Node.js and Python3 installed. https://nodejs.org (which includes npm) https://www.python.org/downloads/
Also, ensure you have an Open API key (this will be needed in your .env file, which you will need to add- directions for this are later)
- Clone the repository
git clone <your-repository-url>
cd <your-project-folder>- Install dependencies in the frontend.
cd finsight-frontend
npm install
may also need to install firebase, so if needed, run:
npm install firebase react-router-dom- Navigate to the backend
cd finsight-backend
# To create the environment
python -m venv venv
# NOTE: you only have to create the environment in your local repository once.
# Activate according to your system. You will have to activate everytime you wish to run
# the backend, otherwise it will not work.
# Windows
venv\Scripts\activate
# macOS/Linux
source venv/bin/activate
Install Required Python packages
```bash
pip install Flask openai flask-cors python-dotenv
```
Create a .env file in the 'finsight-backend' directory. This is where you will
add your OpenAI Key. Set it up as:
'OPENAI_API_KEY="YourAPIKeyHere"' Please ensure the key is safe and secure.The project is still in development mode, hence, you will need two separate terminals to run the backend and frontend servers.
In the first terminal, navigate to finsight-backend. ENSURE THAT THE VIRTUAL ENVIRONMENT IS ACTIVATED. Now, Run the Flask Server:
Run the Flask server:
bash python backend_server.py
The backend will now be running at http://127.0.0.1:5000.
In the second terminal, navigate to finsight-frontend. Run the react app:
npm start
```
Your browser should automatically open to `http://localhost:3000`.
## Technologies
- React.js frontend styled with Tailwind.css, Lucide-React library used for the displays
- OpenAI API Library for the AI Analysis Element
- Python Flask Server for the backend
- Techstack TBD: Database, Login system