Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luigirazum/money-compass
MoneyCompass is a mobile web application where you can manage your budget. You have a list of payments associated with a category, so that you can see how much money you spent and on what. It allows you to register and log in to keep the data private, introduce new categories and payments and see the money spent on each category. Give it a try!
https://github.com/luigirazum/money-compass
authentication autorization budget integration-testing mobile-app model-view-controller mvc-pattern postgresql rails ruby-on-rails unit-testing validation
Last synced: 4 days ago
JSON representation
MoneyCompass is a mobile web application where you can manage your budget. You have a list of payments associated with a category, so that you can see how much money you spent and on what. It allows you to register and log in to keep the data private, introduce new categories and payments and see the money spent on each category. Give it a try!
- Host: GitHub
- URL: https://github.com/luigirazum/money-compass
- Owner: luigirazum
- License: mit
- Created: 2024-02-26T08:01:35.000Z (9 months ago)
- Default Branch: dev
- Last Pushed: 2024-03-04T15:37:27.000Z (9 months ago)
- Last Synced: 2024-08-23T19:49:20.340Z (3 months ago)
- Topics: authentication, autorization, budget, integration-testing, mobile-app, model-view-controller, mvc-pattern, postgresql, rails, ruby-on-rails, unit-testing, validation
- Language: Ruby
- Homepage:
- Size: 364 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### About
**MoneyCompass** is a mobile _Budget Application_ where you can manage your budget. [See more...](#about-project)
# 📗 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)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Run](#run)
- [Open](#open)
- [👥 Author](#author)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
🤷♂️ **MoneyCompass** is a mobile _Budget Application_ where you can manage your budget.\
📃 You have a list of **Payments** associated with a **Category**, so that you can see how much money you spent and on what.\
👤 It allows you to register and log in to _keep_ the _data private_, introduce _**new categories**_ and _**new payments**_ and see the money spent on each category.\
🧑💻 It's a fully functional _web app_ created with [Rails](https://rubyonrails.org/).\
💾 All the data is preserved using a [PostgreSQL](https://www.postgresql.org/) _Database_.
- ### Building the **MoneyCompass** App
It follows the next **ERD** data model:
This project keep the following _Design Guidelines_:
**Original design** idea by [**Gregoire Vella**](#gregoire-vella) on [**Behance**](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding).
This project is made to prove our knowledge and learn more about [**Ruby on Rails**](https://rubyonrails.org/) concepts - starting from the _**Views**_ and finishing the _**database connection**_. We will also **implement** ideas like _**authentication**_, _**authorization**_, and _**testing**_.
**MoneyCompass** users will be able to:
- **Create** _Categories_ to group their payments.
- **Create** _Payments_ for a given _Category_.
- **List** their _Categories_ and _Payments_.
- **Register** in the app with an email and password.
- **Log in** the app so only the user can see their categories and payments.
- [MoneyCompass Live Demo](https://lit-forest-67612-7ce27a105121.herokuapp.com/)
To get a local copy of this project up and running, follow these steps.
- ### Prerequisites
- `git` installed. Please got to [Getting Started - Installing Git guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and follow the steps described for your system to install `git`.
- `Ruby` installed, you can go to the [Installing Ruby](https://www.ruby-lang.org/en/documentation/installation/) documentation and follow the steps for your computer OS.
- `Rails` installed, you can follow the [GoRails Tutorial](https://gorails.com/setup/) and follow the steps for your computer OS.
- `PostgreSQL` installed, you can follow the [PostgreSQL Tutorial](https://www.postgresqltutorial.com/) and follow the steps for your computer OS.
- ### Setup
Clone this repository to your `local-folder`:
```sh
cd local-folder
git clone [email protected]:luigirazum/money-compass.git
```
- ### Usage
In the `local-folder` where you cloned the project, go into the project folder
```sh
cd money-compass
```
- ### Prepare
In the `money-compass` folder, use the following code to install the app dependencies
```rb
bundle install
```
- ### Run
In the `money-compass` folder, use the following code to run the app
```rb
rails server
```
- ### Open
Open your favorite `browser` and type in the address bar
```sh
http://localhost:3000
```
👨💻 **Luis Zubia**
- **Delete** a _Category_ or _Payment_ previously created.
- **Download** all the _Payments_ and _Categories_.
- **Edit** a _Payment_ so it can be associated with another _Category_.
Contributions, issues, typos, and feature requests or suggestions are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, I will really appreciate your support, and don't forget to give a ⭐ to this repository.
- I would like to thank [Yukihiro “Matz” Matsumoto](http://www.rubyist.net/~matz/) for creating the [Ruby Programming Language](https://www.ruby-lang.org/en/).
- Thanks [David Heinemeier Hansson](https://en.wikipedia.org/wiki/David_Heinemeier_Hansson) for sharing [Rails](https://rubyonrails.org/) to the world.\
_**Wikipedia:** [Ruby on Rails - History](https://en.wikipedia.org/wiki/Ruby_on_Rails)_
- Also thanks to [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) for his original idea on the [Design Guidelines](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding) used in this project under the [**CreativeCommons**](https://creativecommons.org) [**CC BY-NC 4.0 Deed**](https://creativecommons.org/licenses/by-nc/4.0/deed.en) License.
- Last but not least, thanks to the amazing [**Microverse**](https://www.microverse.org/) community.
This project is [MIT](./LICENSE) licensed.