📗 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
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Budget App]

[Budget app ] is a web application developed with ruby and rails which helps every one how to 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

Client

• Ruby

Server

• Ruby on rails.js

Database

• PostgreSQL

Key Features

• [Data modeling]
• [Controller]
• [View]

(back to top)

🚀 Live Demo

• Live Demo Link
• Video Explaination 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:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Tekhlay/Budget-app.git

Install

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  bin/rails test
  rspec spec

Deployment

You can deploy this project using: Herekou or vercle.

(back to top)

👥 Authors

👤 Tekhlay

• GitHub: @Tekhlay
• Twitter: @Tekhlay
• LinkedIn: Tekhlay

🔭 Future Features

• [Add api documentation]
• [Add pagination]
• [automated testing]

(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 share with your partners.

(back to top)

🙏 Acknowledgments

• I would like to thank @Microverse online school and
• Credit to: Gregoire Vella on Behance the author of the original design

(back to top)

❓ FAQ (OPTIONAL)

• [How to run ruby file?]

  • [ruby filename.rb]

• [How to test in ruby]

  • [Using Rspec]

(back to top)

📝 License

This project is MIT licensed.

(back to top)