/cash-flow-nexus

Primary LanguageRubyMIT LicenseMIT

Cash Flow Nexus

📗 Table of Contents

📖 [Cash Flow Nexus]

[Cash Flow Nexus] is a mobile web application where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

🛠 Built With

Tech Stack

Ruby on Rails
  • https://rubyonrails.org/

Key Features

  • [Categories]
  • [Transactions]

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

  • Install Ruby
  • Install Rails
  • Install Postgresql

Setup

Clone this repository to your desired folder:

cd cash-flow-nexus
git clone https://github.com/0sugo/cash-flow-nexus.git

Install

Install this project with:

cd cash-flow-nexus
bundle install && npm install

Usage

To run the project, execute the following command:

rails s

Run tests

To run tests, run the following command:

rubocop --color
npx stylelint "**/*.{css,scss}"
rspec spec

Deployment

  • The website is deployed here

👥 Authors

👤 JOSECK OSUGO

🔭 Future Features

  • [Tracking most frequent transactions]

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project please show support by staring ⭐️.

🙏 Acknowledgments

  • I am grateful to Gregoire Vella on Behance for the priviledge to use his design.

  • I would like to thank my Microverse team and my coding partners for their support and guidance.

Presentation

  • I made a short video presentation.

📝 License

This project is MIT licensed.

(back to top)