Aquinasmoriasi/budget-app

Microverse README Template

📗 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

This is a mobile application that allows users to add expenditures for easy tracking of their monetary usage. Users need to sign up to use this application.

🛠 Built With

• Ruby on Rails
• Postgresql

Tech Stack

• Bootstrap
• Node
• Ruby gems
• Capybara
• RSpec

Server

• Heroku

Database

• PostgreSQL

Key Features

• User authentication
• Addition of new categories and expenses
• Side menu

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

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

• Clone this repository by writing git clone https://github.com/Aquinasmoriasi/budget-app.git
• Run bundle install to install the project's dependencies
• Add your database username and password and write rails db:create to create the database
• Run rails db:migrate to migrate the tables to the created database
• Run rails server to open the local host
• To run the tests write rspec <path to the spec file> to run the application's test

Prerequisites

In order to run this project you need:

• Install PostgreSQL in your machine
• install Ruby and Ruby on rails
• Install your preferred IDE(Visual Studio is highly recommended)
• Then run:

 bundle install

Setup

• Clone this repository to your desired folder
• Navigate to the cloned repository and follow the aforementioned steps to get started

Install

Install this project with:

• PostgreSQL
• Ruby
• Ruby on Rails

Usage

To run the project, execute the following command:

rails server

Run tests

To run tests, run the following command:

rspec <relative path to the test file>

Deployment

This project is deployed at https://stormy-plateau-90686.herokuapp.com/

(back to top)

👥 Author

👤 Aquinas Moriasi

• GitHub: Aquinas Moriasi
• Twitter: @Aquinas747
• LinkedIn: Aquinas Moriasi

(back to top)

🔭 Future Features

This project will eventually include:

• A desktop version
• A feature to enable users upload their profile pictures
• QR code integration to process payments

(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 support it by adding a star at https://github.com/Aquinasmoriasi/budget-app/stargazers

(back to top)

🙏 Acknowledgments

I would like to thank Gregoire Vella whose design idea inspired this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)