Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nkaleth/budget-app

This project is a Full Stack mobile web application built in Ruby on Rails 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/nkaleth/budget-app

boostrap5 deployment flyio ruby-on-rails

Last synced: 7 days ago
JSON representation

This project is a Full Stack mobile web application built in Ruby on Rails 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.

Awesome Lists containing this project

README

        

# 📗 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 ](#faq)
- [📝 License](#license)

# 📖 Budget-app

**Budged-app** is a project about building 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

Client

Server

Database

### Key Features

> Describe between 1-3 key features of the application.

- **Use database migration files to maintain database schema.**
- **Build a webapp that requires the user to log in.**
- **Use devise gem for authentication.**
- **Use cancancan gem for authorization.**
- **Follow wireframe for design.**
- **Deploy the app**

(back to top)

## 🚀 Live Demo

- [Live Version](https://finance-friend.fly.dev/)

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:
- [Ruby on Rails](https://rubyonrails.org/) installed and running. To get more information, read the [installation guide](https://guides.rubyonrails.org/).

- [PostgreSQL](https://www.postgresql.org/) installed and running
### Setup

Clone this repository to your desired folder:

```
git clone [email protected]:Nkaleth/budget-app.git
cd Recipe-app
```

### Install

```sh
bundle install
```
```sh
npm install
```
```sh
rails assets:precompile
```

### Usage

To run the project, execute the following command:

```sh
rake db:drop db:create db:migrate db:seed
rails server
```

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Nilton Segura**

- GitHub: [@Nkaleth](https://github.com/Nkaleth)
- Twitter: [@NoeSeguraL](https://twitter.com/NoeSeguraL)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/niltonsegura/)

(back to top)

## 🔭 Future Features

> Describe 1 - 3 features you will add to the project.

- **Complete Desktop Version**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project feel free to fork it and use it as you need and don't forget to start it!.

(back to top)

## 🙏 Acknowledgments

I would like to thank [Gregoire Vella](https://www.loom.com/share/f709065456fe47d99adc66c34aaea9f5) for the idea of the design.

(back to top)

## ❓ FAQ

- **Can I use the project for any purpose?**

- Yes, you can use this files for anything you need

- **Do I need to ask for permission?**

- No need to ask for permission.

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)