{"id":19772998,"url":"https://github.com/luigirazum/money-compass","last_synced_at":"2026-05-06T09:40:44.884Z","repository":{"id":224634190,"uuid":"763394028","full_name":"luigirazum/money-compass","owner":"luigirazum","description":"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!","archived":false,"fork":false,"pushed_at":"2024-03-04T15:37:27.000Z","size":373,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-01-11T01:11:59.407Z","etag":null,"topics":["authentication","autorization","budget","integration-testing","mobile-app","model-view-controller","mvc-pattern","postgresql","rails","ruby-on-rails","unit-testing","validation"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luigirazum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-26T08:01:35.000Z","updated_at":"2024-03-04T15:33:54.000Z","dependencies_parsed_at":"2025-01-11T01:11:40.803Z","dependency_job_id":"9bbf8abb-d91d-454c-9e9e-050a713b1a46","html_url":"https://github.com/luigirazum/money-compass","commit_stats":null,"previous_names":["luigirazum/money-compass"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luigirazum%2Fmoney-compass","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luigirazum%2Fmoney-compass/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luigirazum%2Fmoney-compass/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luigirazum%2Fmoney-compass/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luigirazum","download_url":"https://codeload.github.com/luigirazum/money-compass/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241104137,"owners_count":19910379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","autorization","budget","integration-testing","mobile-app","model-view-controller","mvc-pattern","postgresql","rails","ruby-on-rails","unit-testing","validation"],"created_at":"2024-11-12T05:08:20.518Z","updated_at":"2026-05-06T09:40:39.852Z","avatar_url":"https://github.com/luigirazum.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n  \u003cimg src=\"https://ik.imagekit.io/dqd3uh1at/budget-app/design-guides/app_icon_circled.svg?updatedAt=1708991848772\" alt=\"logo\" width=\"120\" height=\"auto\" /\u003e\n  \u003cbr/\u003e\n\n### About\n**MoneyCompass** is a mobile _Budget Application_ where you can manage your budget. [See more...](#about-project)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\u003chr width=\"250px\"/\u003e\u003c/div\u003e\n\n# 📗 Table of Contents\n\n- [💬 About the project](#about-project)\n  - [🛠 Built With](#built-with)\n    - [Tech Stack](#tech-stack)\n  - [Key Features](#key-features)\n  - [🚀 Live Demo](#live-demo)\n- [💻 Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Setup](#setup)\n  - [Usage](#usage)\n  - [Run](#run)\n  - [Open](#open)\n- [👥 Author](#author)\n- [🔭 Future Features](#future-features)\n- [🤝 Contributing](#contributing)\n- [⭐️ Show your support](#support)\n- [🙏 Acknowledgements](#acknowledgements)\n- [📝 License](#license)\n\n\u003cdiv align=\"center\"\u003e\u003chr width=\"250px\"/\u003e\u003c/div\u003e\n\n# 💰**MoneyCompass** \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\n  🤷‍♂️ **MoneyCompass** is a mobile _Budget Application_ where you can manage your budget.\\\n  📃 You have a list of **Payments** associated with a **Category**, so that you can see how much money you spent and on what.\\\n  👤 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.\\\n  🧑‍💻 It's a fully functional _web app_ created with [Rails](https://rubyonrails.org/).\\\n  💾 All the data is preserved using a [PostgreSQL](https://www.postgresql.org/) _Database_.\n\n- ### Building the **MoneyCompass** App \u003ca name=\"howto-build\"\u003e\u003c/a\u003e\n\n  It follows the next **ERD** data model:\n\n  \u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://ik.imagekit.io/dqd3uh1at/budget-app/erd/erd_diagram.png?updatedAt=1707740376788\" alt=\"Data model\" width=\"500px\"  /\u003e\n  \u003c/p\u003e\n\n    \n  This project keep the following _Design Guidelines_:\n\n  \u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://ik.imagekit.io/dqd3uh1at/budget-app/design-guides/splash.png?updatedAt=1708939267622\" alt=\"splash screen\" width=\"200px\" /\u003e\n    \u003cimg src=\"https://ik.imagekit.io/dqd3uh1at/budget-app/design-guides/transactions.png?updatedAt=1708939268233\" alt=\"payments\"  width=\"200px\"  /\u003e\n  \u003c/p\u003e\n\n  \u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://ik.imagekit.io/dqd3uh1at/budget-app/design-guides/register.png?updatedAt=1708939267302\" alt=\"registration\"  width=\"200px\"  /\u003e\n    \u003cimg src=\"https://ik.imagekit.io/dqd3uh1at/budget-app/design-guides/login.png?updatedAt=1708939267116\" alt=\"login\"  width=\"200px\"  /\u003e\n  \u003c/p\u003e\n\n  **Original design** idea by [**Gregoire Vella**](#gregoire-vella) on [**Behance**](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding).\n\n  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**_.\n\n## 🛠 Built With \u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n- ### Tech Stack \u003ca name=\"tech-stack\"\u003e\u003c/a\u003e\n\n  \u003cul\u003e\n     \u003cli\u003e\n      \u003ca href=\"https://www.ruby-lang.org/en/\"\u003e\n      \u003cimg align=\"center\" width=\"19\" height=\"auto\" src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Ruby_logo.svg/198px-Ruby_logo.svg.png?20101129171534\" alt=\"ruby logo\" /\u003e\n      Ruby\n      \u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"https://rubyonrails.org/\"\u003e\n      \u003cimg align=\"center\" width=\"19\" height=\"auto\" src=\"https://ik.imagekit.io/dqd3uh1at/logos/rails-red-logo.svg?updatedAt=1704962146563\" alt=\"ruby logo\" /\u003e\n      Rails\n      \u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"https://www.postgresql.org/\"\u003e\n      \u003cimg align=\"center\" width=\"19\" height=\"auto\" src=\"https://wiki.postgresql.org/images/3/30/PostgreSQL_logo.3colors.120x120.png\" alt=\"postgreSQL logo\" /\u003e\n      PostgreSQL\n      \u003c/a\u003e\n    \u003c/li\u003e\n  \u003c/ul\u003e\n\n\u003c!-- Features --\u003e\n\n- ### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\n  **MoneyCompass** users will be able to:\n    - **Create** _Categories_ to group their payments.\n    - **Create** _Payments_ for a given _Category_.\n    - **List** their _Categories_ and _Payments_.\n    - **Register** in the app with an email and password.\n    - **Log in** the app so only the user can see their categories and payments.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## 🚀 Live Demo \u003ca name=\"live-demo\"\u003e\u003c/a\u003e\n\n- [MoneyCompass Live Demo](https://lit-forest-67612-7ce27a105121.herokuapp.com/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## 💻 Getting Started \u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\nTo get a local copy of this project up and running, follow these steps.\n\n- ### Prerequisites\n\n  - `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`.\n  - `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.\n  - `Rails` installed, you can follow the [GoRails Tutorial](https://gorails.com/setup/) and follow the steps for your computer OS.\n  - `PostgreSQL` installed, you can follow the [PostgreSQL Tutorial](https://www.postgresqltutorial.com/) and follow the steps for your computer OS.\n\n- ### Setup\n  Clone this repository to your `local-folder`:\n  ```sh\n  cd local-folder\n  git clone git@github.com:luigirazum/money-compass.git\n  ```\n- ### Usage\n  In the `local-folder` where you cloned the project, go into the project folder\n  ```sh\n  cd money-compass\n  ```\n- ### Prepare\n  In the `money-compass` folder, use the following code to install the app dependencies\n  ```rb\n  bundle install\n  ```\n- ### Run\n  In the `money-compass` folder, use the following code to run the app\n  ```rb\n  rails server\n  ```\n- ### Open\n  Open your favorite `browser` and type in the address bar\n  ```sh\n  http://localhost:3000\n  ```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\u003c!-- AUTHORS --\u003e\n\n## 👥 Author \u003ca name=\"author\"\u003e\u003c/a\u003e\n\n👨‍💻 **Luis Zubia**\n\n\u003cul\u003e\n  \u003cli\u003e\n    \u003ca href=\"https://github.com/luigirazum\"\u003e\n    \u003cimg align=\"center\" width=\"18px\" src=\"https://upload.wikimedia.org/wikipedia/commons/2/24/Github_logo_svg.svg\" alt=\"github logo\" /\u003e\n    \u003cb\u003e@luigirazum\u003c/b\u003e\n    \u003c/a\u003e\n  \u003c/li\u003e\n  \u003cli\u003e\n    \u003ca href=\"https://twitter.com/LuigiRazum\"\u003e\n    \u003cimg align=\"center\" width=\"18px\" src=\"https://ik.imagekit.io/dqd3uh1at/logos/x-new-logo.svg?updatedAt=1704962156902\" alt=\"twitter logo\" /\u003e\n    \u003cb\u003e@LuigiRazum\u003c/b\u003e\n    \u003c/a\u003e\n  \u003c/li\u003e\n  \u003cli\u003e\n    \u003ca href=\"https://linkedin.com/in/luiszubia\"\u003e\n    \u003cimg align=\"center\" width=\"18px\" src=\"https://upload.wikimedia.org/wikipedia/commons/c/ca/LinkedIn_logo_initials.png\" alt=\"linkedin logo\" /\u003e\n    \u003cb\u003e/luiszubia\u003c/b\u003e\n    \u003c/a\u003e\n  \u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- FUTURE FEATURES --\u003e\n\n## 🔭 Future Features \u003ca name=\"future-features\"\u003e\u003c/a\u003e\n\n- **Delete** a _Category_ or _Payment_ previously created.\n- **Download** all the _Payments_ and _Categories_.\n- **Edit** a _Payment_ so it can be associated with another _Category_.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## 🤝 Contributing \u003ca name=\"contributing\"\u003e\u003c/a\u003e\n\nContributions, issues, typos, and feature requests or suggestions are welcome!\n\nFeel free to check the [issues page](../../issues/).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- SUPPORT --\u003e\n\n## ⭐️ Show your support \u003ca name=\"support\"\u003e\u003c/a\u003e\n\nIf you like this project, I will really appreciate your support, and don't forget to give a ⭐ to this repository.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n\n## 🙏 Acknowledgments \u003ca name=\"acknowledgements\"\u003e\u003c/a\u003e\n\n- 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/).\n- Thanks [David Heinemeier Hansson](https://en.wikipedia.org/wiki/David_Heinemeier_Hansson) for sharing [Rails](https://rubyonrails.org/) to the world.\\\n_**Wikipedia:** [Ruby on Rails - History](https://en.wikipedia.org/wiki/Ruby_on_Rails)_\n\u003ca name=\"gregoire-vella\"\u003e\u003c/a\u003e\n- 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.\n- Last but not least, thanks to the amazing [**Microverse**](https://www.microverse.org/) community.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- FAQ (optional)\n\n## ❓ FAQ \u003ca name=\"faq\"\u003e\u003c/a\u003e\n\n\u003e Add at least 2 questions new developers would ask when they decide to use your project.\n\n- **[Question_1]**\n\n  - [Answer_1]\n\n- **[Question_2]**\n\n  - [Answer_2]\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n--\u003e\n\u003c!-- LICENSE --\u003e\n\n## 📝 License \u003ca name=\"license\"\u003e\u003c/a\u003e\n\nThis project is [MIT](./LICENSE) licensed.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluigirazum%2Fmoney-compass","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluigirazum%2Fmoney-compass","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluigirazum%2Fmoney-compass/lists"}