MudasirSherwani / Rails-Budget-App

Rails Budget App

📗 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

📖 Rails Budget App

The project 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

BackEnd

• Rails

Test

• RSPEC

Database

• PostgreSQL

Key Features

• [Login / Registration page]
• [Categories page]
• [Transactions page]

(back to top)

🚀 Live Demo

• Live demo link

(back to top)

💻 Video Demo

• Video demo link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby on Rail Knowledge
• Object Oriented Programming(OOP) Knowledge
• Vs Code
• Github / Git Bash
• install ruby

 sudo apt-get install ruby-full

• install rails

    gem install rails
  

• Install gems of rails

    bundle install

• install postgresql

    sudo apt-get install postgresql postgresql-contrib libpq-dev

Setup

Clone this repository to your desired folder:

  git clone [e-mail]:MudasirSherwani/Rails-Budget-App.git
  cd Rails-Budget-App

Prepare the database:

• create database

  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  Rspec

(back to top)

👥 Authors

👤 Mudasir Sherwani

• GitHub: @Mudasir Sherwani
• Twitter: @Mudasir Sherwani
• LinkedIn: @Mudasir Sherwani

(back to top)

🔭 Future Features

• REST Full API

(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 give me a star.

(back to top)

🙏 Acknowledgments

• I would like to thanks Microverse to guide me to complete this project.
• This design was an inspiration by Gregoire Vella on Behance, the author of the original design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)