Sonickmumba/budget_app

Budget app is a mobile web application where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what. It is built using Ruby on Rails.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Budget app

Budget_app is a mobile web application where one can manage their budget: have a list of transactions associated with a category, so that one can see how much money you spent and on what. It is built using Ruby on Rails.

ERD Diagram

🛠 Built With

Tech Stack

Languages

• Ruby
• Rails
• Javascript
• HTML
• CSS

Frameworks

• Ruby on Rails

Server

• Puma

Database

• PostgreSQL

Testing library

• RSpec

Key Features

• [A splash screen page]
• [A login page]
• [A Sign up page]
• [A registration page]
• [A Category page (with all CRUD implementation, except for 'update')]
• [A Transactions page (with all CRUD implementation, except for 'update')]
• [Add Transactions page]
• [Add Category page]

(back to top)

🚀 Live video

• Live video Link

(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:

Ruby version : ruby 3.1.2p20 run ruby -v Database : PostgreSQL

 gem install rails

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone git@github.com:Sonickmumba/Budget-app.git

Install

Install this project with:

  cd budget_app
  bundle install

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

The app is tested using Rspec library you can check the tests by opening your terminal, then change the directory to the location of this repo using this command cd file_path, then run this command gem install rspec, finally run this command rspec spec or rspec spec --format doc for documented test results you should see a screen like that comming soon

Example command:

  bin/rails test test/models/article_test.rb

Deployment

You can deploy this project using:

🚀 Live Demo

• Live Demo Link

(back to top)

👥 Authors

👤 Sonick Mumba

• GitHub: @Sonickmumba
• Twitter: @Sonick
• LinkedIn: Sonick Mumba

(back to top)

🔭 Future Features

• [Have a decent desktop design for the webapp.]
• [Implement the left side menu to improve the navigability of the app.]
• [implement some UX improvements: include transitions and/or animations, etc]
• [Add a footer]

(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 it a thumb up : 👍 and share this projects with your friends

(back to top)

🙏 Acknowledgments

I would like to thank...

• Gregoire Vella on Behance for the design of the project.
• Microverse for giving the opportunity to learn
• Code reviewers and coding partners
• Hat tip to anyone whose code was used
• Inspiration

(back to top)

📝 License

This project is MIT licensed.

(back to top)