https://github.com/wingkwong/squirrel

:squirrel: A responsive expense tracker built with Django to help you manage your expenses :money_with_wings::money_with_wings::money_with_wings:
https://github.com/wingkwong/squirrel

django django-expense-tracker expense-management expense-tracker

Last synced: 10 days ago
JSON representation

:squirrel: A responsive expense tracker built with Django to help you manage your expenses :money_with_wings::money_with_wings::money_with_wings:

• Host: GitHub
• URL: https://github.com/wingkwong/squirrel
• Owner: wingkwong
• License: mit
• Created: 2018-02-18T11:19:23.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T11:36:24.000Z (11 months ago)
• Last Synced: 2024-05-01T15:59:34.644Z (7 months ago)
• Topics: django, django-expense-tracker, expense-management, expense-tracker
• Language: Python
• Homepage:
• Size: 201 KB
• Stars: 11
• Watchers: 4
• Forks: 13
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Squirrel

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fwingkwong%2Fsquirrel.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fwingkwong%2Fsquirrel?ref=badge_shield)

## About

A responsive web application for expense tracking and analytics platform powered by Django

## Installed apps:

* django 2.0.8

* django.contrib.admin

* django.contrib.auth

* django.contrib.contenttypes

* django.contrib.sessions

* django.contrib.messages

* django.contrib.staticfiles

* tracker.apps.TrackerConfig

* django_tables2

* django_filters

* crispy_forms

* tracker.templatetags.month_labels

* social_django

## Configured URLs:

* ``/``

* ``/tracker``

* ``/tracker/add``

* ``/tracker/update/{id}``

* ``/analytics``

* ``/analytics/{year}``

* ``/analytics/{year}/{month}``

* ``/analytics/{year}/{month}/{day}``

* ``/accounts/register``

* ``/accounts/login``

* ``/accounts/logout``

* ``/accounts/profile/{id}``

* ``/dashboard``

* ``/auth/``

* ``/admin/``

## Templates:

Landing:

* ``landing/index.html``

Tracker:

* ``tracker/expense_form.html``

* ``tracker/from_template.html``

* ``tracker/header.html``

* ``tracker/index.html``

* ``analytics/index.html``

Accounts:

* ``registration/login.html``

* ``registration/logged_out.html``

## Features:

* Responsive

* Expense Overview with filtering

* Expense Addition

* Expense Analytics by year, month or day

* Google OAuth2

## Prerequisites

- Python >= 3.5

- pip3

## Setup Your Environment

1. Fork this project

2. Install from the given requirements file.

```bash

pip3 install -r requirements.txt

```

3. Make Migrations

```bash

python3 manage.py makemigrations

```

4. Migrate

```bash

python3 manage.py migrate

```

5. Run

```bash

python3 manage.py runserver

```

## Setup Your Google OAuth

1. Go to Google Developers Console(https://console.developers.google.com/apis/library?project=_) and create a new project

2. Go to credentials tab

3. Create Credentials and choose OAuth Client ID

4. Select Web Application and enter any name in 'Product name shown to users' under OAuth Consent Screen tab

5. Set `http://127.0.0.1:8000/auth/complete/google-oauth2/` in Authorized redirect URIs

6. Under APIs and services tab, click on Google+ API and then click Enable

7. Copy the Client ID and Client Secret Under settings.py

```bash

SOCIAL_AUTH_GOOGLE_OAUTH2_KEY='' # ClientKey

SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET=''# SecretKey

```

## Authors

* **Wing Kam WONG** -  [@wingkwong](https://github.com/wingkwong)

## Contributor

* **Tushar Kapoor** -  [@TusharKapoor23](https://github.com/TusharKapoor23)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fwingkwong%2Fsquirrel.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fwingkwong%2Fsquirrel?ref=badge_large)