/every-penny

This project is created as part of the rails capstone at Microverse. This app is a mobile web application where a user manage its budget: have a list of transactions associated with a category, so that the user can see how much money it spent and on what.

Primary LanguageRubyMIT LicenseMIT

📗 Table of Contents

📖 [Every Penny]

This project is created as part of the rails capstone at Microverse. This app is a mobile web application where a user manage its budget: have a list of transactions associated with a category, so that the user can see how much money it spent and on what.

  • View Recipes for the logged in user
  • logged in user can delete their recipes
  • Logge in user can add new recipes
  • Logged in user can make the recipe public or private
  • Public recipes can be viewd by any user

🛠 Built With

Tech Stack

Server
Database

Key Features

  • Add new categories
  • Delete categories
  • Add new transactions for each category
  • Authentication using Devise gem
  • Authorization using Cancancan gem
  • Splash screen showing the name of the App and options to log in/sign up

(back to top)

🚀 Live Demo

(back to top)

🚀 Video Project Presentation

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You need the following tools be installed in your computer:

Setup

Clone this repository to your desired folder:

  cd my-prefered-folder
  
  git clone https://github.com/Wahaj-Ali/every-penny.git

Install

Install this project with:

  cd every-penny
  
  bundle install

Database creation

Next, use this command to create the databases:

rails db:create
rails db:migrate

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

To run tests, run the following command:

before you run the tests

rails db:seed RAILS_ENV=test
  rspec spec/

or :

rspec spec/models
rspec spec/views

👥 Authors

👤 Wahaj Ali

(back to top)

🔭 Future Features

  • Sidebar menu for the mobile version
  • Some UX improvements: include transitions and/or animations, etc.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give a⭐️ and share with your friends.

(back to top)

🙏 Acknowledgments

  • Thanks to the Microverse team for the great curriculum.
  • Hat tip to anyone whose code was used
  • I would like to thank "Gregoire Vella" for the Amazing Design Template.

(back to top)

📝 License

This project is MIT licensed.

(back to top)