theresetuyi/Budget-app-Ruby-on-Rails-capstone-project

Budget-app-Ruby-on-Rails-capstone-project

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Budget App]

budget_app is a Ruby on Rails mobile web application that allows users to keep track of their expenses and categories. have a list of transactions associated with a category, so that the user can see how much money it spent and on what.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Heroku

Database

• PostgreSQL

Key Features

• User Authentication
• Create categories
• Create transactions

(back to top)

🚀 Live Demo

• Live Demo Link
• Loom link

(back to top)

💻 Getting Started

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

Prerequisites

In order to work on this project, you need to have the following dependencies installed:

• Ruby
• Postgresql
• Node.js
• Rails

Setup

Clone this repository to your desired folder:

$ git clone https://github.com/theresetuyi/Budget-app-Ruby-on-Rails-capstone-project.git
$ cd Budget-app-Ruby-on-Rails-capstone-project.git

Install

Install this project with:

$ bundle install

To get all the gems required for the project

Then, run

$ npm install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

 rspec 

Deployment

You can deploy this project using:

    render

(back to top)

👥 Authors

👤 Therese Tuyisabe

• GitHub: @theresetuyi
• Twitter: @THERESETUYISAB2
• LinkedIn: therese-tuyisabe

(back to top)

🔭 Future Features

• It will generate the charts with timeline
• It will include the top expenses

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project...

(back to top)

🙏 Acknowledgments

I would like to thank...

All the template colors, font, and layout distribution for the whole project were designed by Gregoire Vella on Behance. A link to the project can be found here. Check Gregoire for more amazing GUI and Graphic designs!

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)