shella12 / budget-app

With the Budget app, you can easily track and manage your transactions by category. Whether you want to save more, spend less, or plan ahead, the app helps you see where your money goes and how to optimise it. No more wondering how you spent your last pay check!. Built with: Ruby on Rails.

📗 Table of Contents

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

📖 [BudgeIt]

The Budget app keeps track of your transcations It allows the user to:

• register and log in, so that the data is private to them.
• introduce new transactions associated with a category.
• see the money spent on each category.

🛠 Built With

Tech Stack

Server

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• Authentication
• Authorization
• Keep track of each transactions
• Add new transactions
• User friendly interface
• Interactive Navbar

(back to top)

Live demo

Click this live demo

(back to top)

💻 Getting Started

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

Prerequisites

• Ruby (ruby --version)
• SQLite3 (sqlite3 --version)
• Node.js (node --version)
• Yarn (yarn --version)

Install

Since Rails started out as a project full of packages and libraries, and has since become the full-stack framework it is, it can be easy to forget that it is also just a package itself. If these are all good, you can check:

• Rails (rails --version)

If you get a good version, you're ready to go! (Almost). If you didn't, you may still need to install the Rails gem.

gem install rails

It can be good to keep in mind which version you're using as each of these will update on their own schedule and sometimes the code changes just enough to give us bugs. This will be true for all the packages, gems, APIs, or any other dependencies you may bring into your projects as a developer.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [e-mail]:shella12/budget-app.git

Run

To run this app on your local environment install the gems by running the command bundle install. To create a database run:

rails db:create
rails db:migrate

To insert some data into your database you can run the seed

rails db:seed

Usage

You need to get your Rails application server running,in order to see your app in the browser. This is like live preview in the browser for rails applications. Run :

 $ bin/rails server

OR

$ rails s

visit localhost in your browser!

To exit server enter “Control (^ )+ C”

Tests

To create tests, RSpec testing framework is used. In order to run tests use following command:

 $ rspec spec

Note: You can also run the test by using just rspec but it runs all tests folders and files with name like ****_spec

(back to top)

👥 Authors

👤 Ayesha Arshad

• GitHub: @shella12
• Twitter: @Ayesha Arshad
• LinkedIn: Ayesha Arshad

(back to top)

🔭 Future Features

• Improving UI
• Make an API of this app

(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 please give this repo a star ⭐️

(back to top)

🙏 Acknowledgments

Design credit to Gregoire Vella on Behance the author of the original design

(back to top)

📝 License

This project is MIT licensed.

(back to top)