Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Money Tracker

Build Status Code Climate

Money Tracker

WORK IN PROGRESS

Money Tracker is an open-source progressive web app that allows you to track your income and expenses.

This app can work offline on desktop, tablet and mobile.

Data is stored locally on device in PouchDB database and can be synced to the cloud.

Implemented with React and Semantic UI

License

Our software is distributed under the MIT License.

Installation

Prerequisites

  • npm, which you can install by running:

    npm install npm@latest –g

How to install

  • Clone the repo from this website, then
  • In command line:
    • $ git clone https://github.com/ayastreb/money-tracker.git
    • $ cd money-tracker
    • $ npm install
    • $ npm start

At this point you should see the app running on

http://localhost:3000

And start developing for contribution.

If any questions arise, please see the open issues tab as some of them might have already been answered.

Contributing

If you would like to contribute, please follow these steps:

  1. Open an issue explaining what you want to fix
  2. Fork this project
  3. Create a featureDev_<YourFeaturedName> branch
  4. Add and commit your contribution (s)
  5. Push to your featureDev_<YourFeaturedName> branch
  6. Open a pull request (PR)

As always, if any questions arise, please connect with us via our <communication channel> (see below).

Community Standards

It is our responsibility to build a strong and welcoming community for all developers. Everyone who is willing to contribute is welcome, and her or his work will be considered if it solves an issue.

Please keep in mind that everyone:

  • Must use a welcoming and inclusive language
  • Must be respectful of everyone’s programming skills/backgrounds
  • Must accept constructive criticism, and aim for continues improvement
  • Must support and show empathy towards other community members

Communication Channels

<please add here your preferred communication channel>

Development Tracking

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

You can’t perform that action at this time.