An open API service indexing awesome lists of open source software.

https://github.com/forloop94/rails_budget_app


https://github.com/forloop94/rails_budget_app

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          


Rails Budget App


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Budget App ](#-budget-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Run tests](#run-tests)
- [🚀 Deployment ](#-deployment-)
- [🎞️ Presentation Video ](#️-presentation-video-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Budget App

The **Budget App** is an application that helps the user keep track of financial activities across different categories.

## 🛠 Built With

### Tech Stack

- RUBY
- Rails
- Postgresql
- HTML
- CSS
- Javascript

### Key Features

- [ ] **Login**
- [ ] **Sign Up**
- [ ] **Logout**
- [ ] **Create New category**
- [ ] **Create New transaction**

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

- git
- Ruby
- Rails
- Bundle gem

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone git@github.com:forLoop94/Rails_budget_app.git
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails s
```

### Run tests

To run tests, run the following commands:

```sh
rubocop
rspec spec/
npm run stylelint
```

(back to top)

## 🚀 Deployment
Deployment: [Thrifty](https://thrifty-ma5c.onrender.com/)

(back to top)

## 🎞️ Presentation Video
Video: [Presentation](https://www.loom.com/share/36ae6cb1537b428596be98fbb1ab9c7b)

(back to top)

## 👥 Authors

👤 **Charles Andrews**

- GitHub: [@githubhandle](https://github.com/forLoop94)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/andrewsCharlesUwem/)

(back to top)

## 🔭 Future Features

- [ ] **Stats dashboard**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/forLoop94/Rails_budget_app/issues).

(back to top)

## ⭐️ Show your support

If you like this project give me a follow and/or a star

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for giving me this wonderful opportunity to work on this project
and [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) for the original design.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)