Skip to content

A Personal Finance tracker - (ALX-Personal portfolio project)

Notifications You must be signed in to change notification settings

onaya7/CoinControl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Name: CoinControl

Introduction

Welcome to Coincontrol! This Flask-based web application helps you track your personal finances, allowing you to manage your expenses, income, and savings in an organized manner. With this tool, you can gain valuable insights into your financial habits and make informed decisions to achieve your financial goals.

Link to Deployed Site: [Personal Finance Tracker](coming soon)

Final Project Blog Article: [Read about the development journey](coming soon)

Author's LinkedIn Profile:

Installation

To run the Personal Finance Tracker locally, follow these steps:

  1. Clone the repository from GitHub:
git clone https://github.com/onaya7/CoinControl.git
cd CoinControl
  1. Create a virtual environment(optional but recommended):
python3 -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
  1. Install the required dependencies:
pip install -r requirements.txt
  1. create a .flaskenv and include:
FLASK_APP=app.py
FLASK_ENV=development
FLASK_DEBUG=TRUE
  1. Configure the environmental variables: Rename the .env.example file to .env and update it with your specific configuration details, such as database credentials and API keys.

  2. Then run the application:

flask run

Open your web browser and navigate to http://localhost:5000 to access CoinControl.

Usage

CoinControl provides a user-friendly interface to manage your financial data. Here are some key features

  • Dashboard: Get an overview of your total expenses, income, and savings over time, presented in charts and graphs.

  • Expenses: Add, categorize, and track your expenses. You can also set budgets for each category to manage your spending effectively.

  • Income: Log your sources of income, helping you keep track of your earnings.

  • Savings: Set and monitor your savings goals. The app will help you stay on track to reach your financial targets.

  • Reports: Generate detailed reports to analyze your financial patterns and identify areas for improvement.

Contributing

We welcome contributions to CoinControl project! if you'd like to contribute, please follow these steps:

  1. Fork the repository on Github.

  2. Create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name
  1. Make your modifications and commit your changes:
git commit -m "Add your meaningful commit message"
  1. Push your changes to your forked repository:
git push origin feature/your-feature-name
  1. Submit a pull request to the master branch of the original repository.

Please ensure your code adheres to the project's coding conventions and includes appropriate tests.

Related Projects

Here are some related projects that you might find interesting:

Licensing

CoinControl is released under the MIT License, which allows you to use, modify, and distribute the code freely. See the LICENSE file for more details. MIT LICENSE.

Screenshot

Screenshot (135) Screenshot (148) Screenshot (150) Screenshot (136) Screenshot (137)

About

A Personal Finance tracker - (ALX-Personal portfolio project)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published