https://github.com/andrianarivo/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.
https://github.com/andrianarivo/restaurant-budget

postgresql rails ruby

Last synced: about 17 hours ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/andrianarivo/restaurant-budget
• Owner: andrianarivo
• License: mit
• Created: 2023-09-11T08:49:09.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-11-14T14:59:16.000Z (about 1 year ago)
• Last Synced: 2024-08-22T19:53:30.507Z (6 months ago)
• Topics: postgresql, rails, ruby
• Language: Ruby
• Homepage: https://restaurant-budgeter-f989efe0a108.herokuapp.com/
• Size: 475 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  

  


Restaurant Budget




# 📗 Table of Contents

- [📖 About the Project](#about-project)

    - [🛠 Built With](#built-with)

        - [Tech Stack](#tech-stack)

        - [Key Features](#key-features)

    - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

    - [Setup](#setup)

    - [Prerequisites](#prerequisites)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#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](https://restaurant-budgeter-f989efe0a108.herokuapp.com/)

- [Video presentation](https://www.loom.com/share/Restaurant-Budgetary-c5e5552fb1c442dcaf111998dc1bdff1?sid=6badb8ca-f59a-4588-a966-c83185d18832)

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

```sh

  cd my-folder

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

```

### Install

Install this project with:

```sh

  cd my-project

  bundle install

```

### Usage

To run the project, execute the following command:

```sh

  rails server

```

### Run tests

To run tests, run the following command:

```sh

  rspec spec

```

### Deployment

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

(back to top)


## 👥 Authors 

👤 **David**

- GitHub: [@andrianarivo](https://github.com/andrianarivo)

- Twitter: [@dandrianarivo](https://twitter.com/dandrianarivo)

- LinkedIn: [LinkedIn](https://linkedin.com/in/andrianarivo)

(back to top)


- [ ] **Public restaurants**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/andrianarivo/restaurant-budget/issues).

(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](https://www.behance.net/gregoirevella). 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](./LICENSE) licensed.

(back to top)