Botlhale-Setou / budget-app

📗 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 (OPTIONAL)
• 📝 License

📖 Budget-App

Budget-App Is an application where users can create an account and save different categories to add their expenses. It will help you to keep track of how much money you spend.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Ruby

Database

• PostgreSQL

Key Features

• Use Ruby Gems as a software packages system.
• Use database migration files to maintain database schema
• Use data models with associations.
• Use customize model methods
• Use validation for models
• Use controllers to handle requests and render empty views
• Use preprocessed HTML file with embedded Ruby code.
• Use Rails forms to add categories and transactions
• Use devise with authentication

(back to top)

🚀 Live Demo

• This app was deploy on render, here is the 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: Rails and postgres install on your local computer.

  $ gem install rails

Setup

Clone this repository to your desired folder:

  https://github.com/Botlhale-Setou/budget-app.git

Install

Install this project with:

  $ bundle install

Usage

To run the project, execute the following command:

  $ rails server

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Authors

👤 Botlhale Setou

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Create API
• Allow update and destroy categories and transactions.

(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 do not forget to star the repository.

(back to top)

🙏 Acknowledgments

• Original design idea by Gregoire Vella on Behance

(back to top)

📝 License

This project is MIT licensed.

(back to top)