Skip to content

Dracks/mr-scrooge

Repository files navigation

Mr Scrooge

This is the base repository, to clone and start it using docker.

CodeFactor

File formats suported

Currently this application supports the following bank file formats:

  • Caixabanc Account and card Excel
  • Caixa Enginyers Account and Credit Card
  • Commerce bank
  • N26 CSV file
  • MultiBank QIF File (Thanks to Albert Sola)

(*) To create a new one, can you take a look at the changes from @AlbertSola to add the qif format commit

Demo

You can run the docker image generated for the release inside her: https://hub.docker.com/r/dracks/mrscrooge/

To run, execute the following command:

docker run --rm -p 3333:80 -e DEMODATA="true" dracks/mrscrooge:latest

It will open your port 3333 with user demo/demo

You can set the following environment variables:

  • DEMODATA: Default false. this will create a random data with tags and graphs
  • DEMOUSER: default "demo". The username to create on the application
  • DEMOPWD: default "demo". The password for the user
  • ALLOWED_HOSTS: default "localhost". You can put a list of hosts separed with a comma character
  • DECIMAL_COUNT: default 2, the number of digits to show in the graphs

Screenshots MVP

Home

Report in desktop Report in mobile Import in desktop Tags in desktop Data in desktop Data in mobile

How to contribute

  1. Fork the branch develop of the part you wish to contribute (mrscrooge-server or mrscrooge-view).
  2. Clone the server and the view repositories
  3. Run it

Run the server

  1. Make sure you have python3 available in your machine
  2. Install dependencies (Recomendable use of virtual env tutorial sample) with: pip install -r requirements.txt
  3. Run the tests ./manage.py test
  4. Run the server ./manage.py runserver

Run the view

  1. Make sure you have node 8.0 or superior
  2. Install dependencies: yarn or npm install
  3. Run the tests yarn test or npm test (It will run with a watcher, this means that don't stop after run the tests waiting for changes)
  4. Run the project yarn start or npm start

Thanks

The current application icon is from VisualPharm