Restaurant Budget

📗 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

📖 Restaurant Budget

Restaurant Budget 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

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• 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.

(back to top)

🚀 Live Demo

• Live Demo Link
• Video presentation

(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:

• Linux Operating system
• Text Editor (VSCode, RubyMine)
• Ruby

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/andrianarivo/restaurant-budget.git

Install

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec spec

Deployment

You can deploy this project using your own deployment service like Render.

(back to top)

👥 Authors

👤 David

• GitHub: @andrianarivo
• Twitter: @dandrianarivo
• LinkedIn: LinkedIn

(back to top)

• Public restaurants

(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 consider adding a ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse. Original design idea by Gregoire Vella on Behance. The design is used under the creative common license. No changes were made to the original design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)