Expense Control

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Usage
3. Getting Started
   • Prerequisites
   • Installation
4. Roadmap
5. Contributing
6. Collaborators
7. License
8. Contact
9. Acknowledgments

About The Project

This project was created to improve my knowledge in Django, html, css, boostrap, javaScript and added another ability to show results in graphs with chartjs, in addition to training different ways of working with django, where I overcame the difficulties of using chartjs and I worked on new ways of working with django using Django's Views classes, along with JavaScript validation, importing data from a json file and saving it in the database, exporting data to CSV and Excel files, with account activation and password recovery via email.

• Expense-control

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Usage

1.User Login Page.

2.Register Page.

3.Reset Password Page.

4.Home Page.

* Dark Mode.

5.Create Expense Data.

6.Edit Expense Data.

7.Search data.

8.View Category data.

9.Create Category data.

10.Edit Category data.

11.Delete Category data.

12.View Income Data.

13.Create Income Data.

14.Edit Income Data.

15.View Source data.

16.Create Source data.

17.Edit Source data.

18.Delete Source data.

19.Preferred Currency.

20.Export CSV.

21.Export Excel.

(back to top)

Prerequisites

• Python

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/HeitorLouzeiro/django-expense-control.git

2. Access the project folder in terminal/cmd

   cd django-expense-control

3. Create a virtualenv with Python 3.9.0.

   python -m venv venv

4. Activate virtualenv.

   • Ubunto

   source venv/bin/activate

   • MacOs

   source venv/bin/activate

   • Windows

    venv\scripts\activate

5. Install as dependencies.

    pip install -r requirements.txt

6. Configure an instance with .env.

    cp .env-example .env

   or

   Copy the env-example to a new file called .env and then open it and change the variable values ​​if necessary

7. Change the .env variables, put your email and gmail password, if you have two-factor security follow the tutorial below.

• Support Google

8. Run the migrations.

    python manage.py migrate

9. Create a Superuser.

    python manage.py createsuperuser

10. Run the application.

     python manage.py runserver

(back to top)

Roadmap

• User Login Page.
• User Register Page.
• Active User Verification.
• Reset Password Page.
• Home Page.
• Create Expense Data.
• Create Expense Data.
• Edit Expense Data.
• Delete Expense Data.
• Search Expense data.
• View Category data.
• Create Category data.
• Edit Category data.
• Delete Category data.
• View Income Data.
• Create Income Data.
• Edit Income Data.
• Delete Income Data.
• View Source data.
• Create Source data.
• Edit Source data.
• Delete Source data.
• Search Income data.
• Export CSV.
• Export Excel.
• Preferred Currency.
• Dark Mode.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/Improvements)
3. Commit your Changes (git commit -m 'Add my new Enhancements')
4. Push to the Branch (git push origin feature/Improvements)
5. Open a Pull Request

(back to top)

Collaborators

We thank the following people who contributed to this project:

Heitor Louzeiro

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/HeitorLouzeiro/django-expense-control

(back to top)