Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🖺 Entity Relationship Diagram
  • 📽️ Project Documentation
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 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.

🛠 Built With

Tech Stack

Ruby

Ruby on Rails

Javascript

Database

• PostgreSQL

Key Features

• 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

(back to top)

📽️ Project Doocumentation

🚀 Live Demo

• My-Exp

• video

(back to top)

💻 Getting Started

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:

  bundle install

  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:

  rails server or rails s  # after build

Run tests

rspec

(back to top)

👥 Author

👤 Mulugeta M.

• GitHub: @belmeetmule
• Twitter: @belmeetmule
• LinkedIn: belmeetmule

(back to top)

🔭 Future Features

• [Notifications that pop up and close]
• [Implement most recent and anicient]
• [Implement picture upload]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• Code reviewers
• Inspiration
  • Vitor Guedes Madeira

Under the the Creative Commons liscense

Original design from Gregoire Vella on Behance

(back to top)

❓ 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

(back to top)

📝 License

This project is MIT licensed.

(back to top)