• 📖 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

📖 [My budget]

[My-budget] 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.

🛠 Built With

Tech Stack

Key Features

• [user_registration]
• [view_categories_&_add_category]
• [view_transactions_&_add_transaction]

🚀 Live Demo

• Live Demo Link

• Video Demo

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• IDE to edit and run the code (We use Visual Studio Code 🔥).
• Git to versionning your work.
• Postgresql

Setup

Clone this repository to your desired folder:

gh repo clone Sevenpros/My-budget

• Then switch to the project folder by the bellow query:

cd My-budget

Install

Install this project with:

• Switch to the project folder by the bellow query:

cd My-budget

-Install the required dependecies with:

bundle install

-Install npm dependencies with:

npm install

Usage

To run the project, execute the following command:

• Before running below commands update config/database.yml with your local DBcredentials. Then run:

rails db:create

rails db:migrate

• With Ruby on Rails and PostgreSQL installed in your environment, you can run rails server to run the website.
  rails s

Run tests

To run tests, run the following command:

• Run bundle install
• Run bundle exec rspec spec

Deployment

You can deploy this project using:

👥 Authors

👤 Seth Bizimana

Github: @Seth

LinkedIn: @Seth

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [create_desktop_version]

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project, you are all welcome to support and make any contributions

🙏 Acknowledgments

I would like to thank Gregoire Vella whose design was used

❓ FAQ

• [can_this_work_in_chrome]

  • [yes]

• [is_this_compatible_with_windows]

  • [Yes]

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.