Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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


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

Last synced: 8 days ago
JSON representation

Awesome Lists containing this project

README

        


Budget-app


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Budget-app](#-catalog-of-things)
- [🛠 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)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Budget-app

This small budget project is 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

- RUBY
- RUBY ON RAILS
- JAVASCRIPT
- HTML
- CSS

### Key Features

- [ ] **Users can create a account.**
- [ ] **Users can add a category of tem**
- [ ] **Users can add transactions to their categories**
- [ ] **Users can see what they spent on a transaction**

(back to top)

## 💻 Getting Started

To get started with this app, you will need to have Ruby and Rails installed on your computer. Once you have Ruby and Rails installed.

## Live demo
[live demo](https://budget-1ccr.onrender.com/)

## Presentation
[Link to video presentation](https://www.loom.com/share/c95e277b5bfc45ada9dd3ee4e891f441?sid=2d7cdd8f-fd81-43b9-9ed8-abc0b9154264)

### Prerequisites

In order to run this project you need:

- git
- Ruby

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/danielsafari143/budget-app.git
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails db:create
rails db:migrate
rails server
```

### Run tests

To run tests, run the following commands:

```sh
rspec
rubocop
```

(back to top)

## 👥 Authors

👤 **Safari Hamuli**

- GitHub: [@danielsafari143](https://github.com/danielsafari143)
- LinkedIn: [Safari Daniel](https://www.linkedin.com/in/safari-daniel/)

(back to top)

## 🔭 Future Features

- [] **Authentification, Authorization**

(back to top)

## 🤝 Contributing

If you would like to contribute to this app, please feel free to fork the repository and submit a pull request.

Feel free to check the [issues page](https://github.com/danielsafari143/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 express my sincere gratitude to [Gregoire Vella](https://www.behance.net/gregoirevella) for this design and to all my Microverse partners who helped me build this project. I could not have done it without your support and encouragement.

(back to top)

## 📝 License

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

(back to top)