luigi-pastorepica/freed

A simple tool to help users easily see the outlook for multiple personal debts. It is expected to assist the user in making decisions on where to allocate additional money to pay less in the long term. This software is intended to be used alongside a data visualization library to display graphs and other data that might be considered pertinent.

freed's Issues

Missing Descriptive Title and Short Descrition

• Rename the project to its own name. This name can change in the future.
• There should be a What is it? section or similar at the beginning of the README. It should be short an allow the potential user or contributor to understand what the project is about without having to read the entire document.

Produce a Simple Visualization

Take the information input by the user and create a visualization. My first idea is to create a simple plot showing how different debts are projected to grow based on current data and applying simple formulas.

Deliverables Tuesday Nov. 17

• Set up personal GitHub pages site
• Include a link to your open source project

Create a Local DB for Customer Data Storage

I have not decided whether to go relational vs. non-relational, nor any DBMS yet. Some ideas are:

• Relational:

• MySQL

• Non-relational:

• Document DB - MongoDB
• Data Structure DB - Redis

Deliverables Thursday Nov. 5

• Set up documentation for project
• Host documentation under readthedocs
• Set up API autodocumentation, include at least 4 elements
• Add readthedocs badge to the Readme.
• Optional:
  • Remember to write down documentation for everything that we have done for this class. (Problems, justification for decisions. What tools and frameworks are used.)
  • Add link to readthedocs page in the Readme.
  • Add Readme's content to the top of the readthedocs page.

Set up documentation and autodocumentation

CONTRIBUTING.md is Empty

Need to come up with contribution guidelines.

Deliverables Thursday Oct. 15

• Setup code coverage SaaS
• Add code coverage badge to README

Set up code coverage

Deliverables Tuesday Oct. 20

• Add linting step to CI

Deliverables Thursday Nov. 19

• Do one of the following:
  • Add example snippets/screenshots to docs
  • Set up example snippets site
  • Set up example app

Create simple user class

The user class will be the main holder of data while the application is in use.
Data to instantiate an user object will come from a database. Such data will be either an entry of a relation in a relational database, a document (e.g. JSON file) stored in a document database (e.g MongoDB), or even a data structure in some other kind of NoSQL database (e.g. Redis).

Deliverables Tuesday Nov. 17

• Tag and push v0.1.0
• Write some introductory release notes on GitHub

Set Up Data Entry GUI

This is not necessary for a PoC right now, but it would be really neat.

Deliverables Tuesday Oct 13

• Set up automated testing for the repo using one of the recommended providers
• Write at least 5 tests to be run during CI
• Modify repo to only accept PRs to master if tests pass
• Add test status badge to README and project proposal

Add linting