Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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


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

Last synced: 14 days ago
JSON representation

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)

# Budget App

> Budget App is a mobile web application that allows you to 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.
----
_[Here](https://www.loom.com/share/f958cea5075e4e7b9a65958038d1f6b7) link to the project presentation video_

_[Here](https://cryptic-refuge-36900.herokuapp.com/) link to the live demo_

---
Splash Screen | Login Page
:-----------------------------------------------------------:|:---------------------------------------------------------:
![screenshot](./app/assets/images/home.png) | ![screenshot](./app/assets/images/login.png)
Transactions Page | Categories Page
![screenshot](./app/assets/images/transac.png) | ![screenshot](./app/assets/images/categories.png)

# Getting Started

_To get a local copy up and running follow these simple steps._

1. Clone the repo
```sh
git clone https://github.com/KayLemba/budget-app.git
```
2. Goto project directory
```sh
cd budget-app
```

3. Configure `database.yml` in the config folder according to your postgreSQL configuration
4. Run app
```sh
rails server.
```
or
```sh
rails s
```

# Testing

`bundle exec rspec` will run all the tests....

Also, you can run `bundle exec rspec spec/` to run specific tests.

You can also run `RAILS_ENV=test rspec spec/` to run the tests in test mode.

## Errors

If you encounter any errors, run the following commands.

- Run `rails db:drop db:create db:migrate` to drop, create and migrate a new database.

- Run `rubocop && rubocop -A` to check for and fix code errors.

# This project was built with

- Ruby on Rails

- PostgreSQL

- Bootstrap CSS Framework

# Authors
👤 **Kalolo Chola Lemba**
- GitHub: [@KayLemba](https://github.com/KayLemba)
- Twitter: [@King-Kaylo1](https://twitter.com/King_Kaylo1)
- LinkedIn: [@kalolo-lemba](https://www.linkedin.com/in/https://www.linkedin.com/in/kalolo-lemba)

# 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page]

# Show your support

Give a ⭐️ if you like this project!

# Acknowledgement

- Hat tip to anyone whose code was a source of inspiration.
- A big thanks to [@microverseinc](https://github.com/microverseinc).
- The design template provider [Gregoire Vella on Behance](https://www.behance.net/gregoirevella).

# 📝 License

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