jennifertakagi/your-money

Manage your finances with this clean application!

Your Money

Manage your finances with this clean application!
Explore the docs »

Report Bug · Request Feature

Table of Contents

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

About The Project

Manage your finances with this clean application.

Features:

• Add a new income transaction
• Add a new outcome transaction
• Check total, income and outcome amount

Built With

• React JS
• TypeScript
• Styled Components
• Polished
• Mirage JS
• Axios

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/jennifertakagi/your-money.git

2. Install packages

   yarn | npm install

3. Run project on the development environment

   yarn start | npm run start

Usage

Roadmap

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

Contributing

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

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

License

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

Contact

Jennifer Takagi - @jennitakagi