Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/belmeetmule/my-exp
My-Exp is a personal expense tracker mobile app that allows users to: create expense category, introduce new transactions associated with a category and see total expense as well as expense per each category. User should register and log in, so that the data is private to them.
https://github.com/belmeetmule/my-exp
javascript postgresql rspec-rails ruby-on-rails shoulda-matchers
Last synced: 20 days ago
JSON representation
My-Exp is a personal expense tracker mobile app that allows users to: create expense category, introduce new transactions associated with a category and see total expense as well as expense per each category. User should register and log in, so that the data is private to them.
- Host: GitHub
- URL: https://github.com/belmeetmule/my-exp
- Owner: belmeetmule
- License: mit
- Created: 2023-02-21T09:27:20.000Z (almost 2 years ago)
- Default Branch: development
- Last Pushed: 2023-04-26T20:52:08.000Z (over 1 year ago)
- Last Synced: 2024-10-03T12:29:37.584Z (3 months ago)
- Topics: javascript, postgresql, rspec-rails, ruby-on-rails, shoulda-matchers
- Language: Ruby
- Homepage: https://my-expenses-3hoz.onrender.com
- Size: 896 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Microverse README Template
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🖺 Entity Relationship Diagram](#er-diagram)
- [📽️ Project Documentation](#pro-doc)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
# 📖 My-Exp
**My-Exp** is a mobile web application that allows the user to:
- register and log in, so that the data is private to them.
- Ceate categories for thier expenses.
- record transactions associated with a category.
- see the money spent on each category.
- see the total money spent on all categories.
Ruby
Ruby on Rails
Javascript
Database
- **Authentication - User must be authenticated**
- **Users can track expenses category-wise**
- **Users can see the total money spent on all categories**
- **Users expense data is private to them**
- [My-Exp](https://my-expenses-3hoz.onrender.com)
- [video](https://www.loom.com/share/050857e34761481fbb81b2fb5ab25923)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
`Git` and `Ruby`
```
gem install rails
```
### Install
Install this project with:
```sh
bundle install
```
```sh
npm install
```
Create Database (Mandatory)
```
rails db:create
```
If you have made a migration then run this command
```
rails db:migrate
```
```
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
rails server or rails s # after build
```
Run tests
```
rspec
```
👤 **Mulugeta M.**
- GitHub: [@belmeetmule](https://github.com/belmeetmule)
- Twitter: [@belmeetmule](https://twitter.com/belmeetmule)
- LinkedIn: [belmeetmule](https://linkedin.com/in/belmeetmule)
- [ ] **[Notifications that pop up and close]**
- [ ] **[Implement most recent and anicient]**
- [ ] **[Implement picture upload]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project!
I would like to thank:
- [Microverse](https://microverse.org)
- Code reviewers
- Inspiration
- [Vitor Guedes Madeira](https://github.com/VitorGuedesMadeira)
Under the the [Creative Commons liscense](https://creativecommons.org/licenses/by-nc/4.0/)
Original design from [Gregoire Vella on Behance](https://www.behance.net/gregoirevella)
## ❓ FAQ
- ** On what platform this app works ?**
- Since it is a web mobile application, you can use it from your mobile-phone and personal computers too. In other words, you can use it from any devise or platfrom as long as it supports web-browser.
- **How to run this app after I cloned it to my local machine ?**
- Start the sever by executing the command `rails server` from your terminal. And open up your browser and visit localhost:3000
- **What prerequisites are required to run the app ?**
- Since it is a RoR app make sure you have rails, ruby and postgresql are installed
This project is [MIT](./MIT.md) licensed.