Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/grandi0z/cents_sense

Cents sense is a mobile web application that helps you manage your budget and track your transactions. You can register and log in with your full name, email and password, and access your personal data securely. You can add new transactions associated with a category, such as food, entertainment, or rent. You can also see the total amount of mo
https://github.com/grandi0z/cents_sense

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/grandi0z/cents_sense
Owner: Grandi0z
License: mit
Created: 2023-11-06T15:37:26.000Z (about 1 year ago)
Default Branch: dev
Last Pushed: 2023-11-12T03:38:26.000Z (about 1 year ago)
Last Synced: 2024-05-17T15:25:45.213Z (8 months ago)
Language: Ruby
Homepage:
Size: 575 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Cents sense ](#-cents-sense-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo](#-live-demo)
- [🚀 Video Demo](#-video-demo)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Cents sense

**Cents sense** is a mobile web application that helps you manage your budget and track your transactions. You can register and log in with your full name, email and password, and access your personal data securely. You can add new transactions associated with a category, such as food, entertainment, or rent. You can also see the total amount of money spent on each category, and compare your expenses with your income. Cents Sense is a simple and smart way to make sense of your money and save more.

## 🛠 Built With

### Tech Stack

Ruby

Rails

Postgresql

(back to top)

### Key Features

- **It allows you to register and log in with your full name, email and password, so that your data is private and secure.**
- **It lets you introduce new transactions associated with a category, such as food, entertainment, or rent, and see the details of each transaction, such as the date, amount, and description**
- **It shows you the total amount of money spent on each category, and the percentage of your budget that each category represents, so that you can see how you allocate your money and where you can save more.**
- **It provides you with a simple and user-friendly interface, with a splash screen, a home page, and a transactions page, that follow the design guidelines of Snapscan, a popular mobile payment app**
- **It is a mobile web application that you can access from any device with a browser, without the need of installing anything**

## 🚀 Live Demo
Demo

## 🚀 Video Demo
Video Demo

## Getting Started

### Prerequisites
In order to run this project, you must have installed and configured ruby in your local environment:
You we also need to setup Postgres database

### Setup

Clone this repository to your desired folder:

Before to run the program, verify that you have Ruby installed on your OS running the following command:

### Usage

Run the following command inside the project folder:
1. Open your terminal and navigate to the root directory of your project.
2. run ```$ rails server```
3. open your navigator
4. Go to ```http://localhost:3000/```
5. Enjoy

(back to top)

### Run tests

Before running tests, ensure you've set up the test database:

```sh
bin/rails db:migrate RAILS_ENV=test
```

```sh
bundle exec rspec ./spec

```

For linters test :

```$
rubocop
```

```$
npx stylelint "**/*.{css,scss}"
```

### Deployment

You can deploy this project using: GitHub Pages Netifly or Render

(back to top)

## 👥 Authors

👤 **Joseph L Kausi**

- GitHub: [@Grandi0z](https://github.com/Grandi0z)
- Twitter: [@Joseph_LSK](https://twitter.com/Joseph_LSK)
- LinkedIn: [Joseph L Kausi](https://www.linkedin.com/in/joskal/)

(back to top)

## 🔭 Future Features

- [ ] **Integration with payment services: This feature would allow you to link your bank accounts and credit cards to the app, and automatically import and categorize your transactions. This would save you time and effort from manually entering each transaction, and also give you a more accurate picture of your spending habits**
- [ ] **Data visualization: This feature would enable you to see your budget and transactions in a graphical and interactive way, such as charts, graphs, and dashboards. This would help you to better understand your financial situation, identify trends and patterns, and compare your performance with your goals**
- [ ] **AI-powered financial assistance: This feature would use artificial intelligence and machine learning to provide you with personalized and smart financial advice, such as how to optimize your budget, save more money, reduce your debt, and invest wisely. This would help you to improve your financial literacy, make better decisions, and achieve your financial goals faster.**

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Grandi0z/cents_sense/issues).

(back to top)

## ⭐️ Show your support

If you like this project, I would like to Thank You!

(back to top)

## 🙏 Acknowledgments

special thanks to [Microverse](https://www.microverse.org/) for providing us with the essential materials for this project and to [Gregoire Vella](https://www.behance.net/gregoirevella) for creating this design.

(back to top)

## 📝 License

This project is [MIT](https://github.com/Grandi0z/cents_sense/blob/dev/LICENSE) licensed.

(back to top)