SavEarly

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 📺 Presentation
• 💻 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 web application that allows users to create a budget and track their expenses. The user can create a budget category and add expenses to it.

🛠 Built With

Tech Stack

Ruby on Rails (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Users Authentication
• users can manage budget with Categories
• Users can add Transactions

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

📺 Presentation

• Link to video presentation

(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 and Rails on you operating system eg. for Ubuntu 20.04
• Node.js installed
• Yarn
• PostgreSQL database installed

Setup

Clone this repository to your desired folder:

  cd my-folder
  https://github.com/yodit93/budget-app.git

Install

Install this project with:

  cd budget-app

  bundle install

Usage

To run the project, execute the following command:

  rails s

Run tests

To run tests, run the following command:

  bin/rails rspec spec

Deployment

You can deploy this project using: Render, Heroku, Netlify, etc.

(back to top)

👥 Authors

👤 Yodit Abebe

• GitHub: yodit93
• Twitter: @yodtwit
• LinkedIn: Yodit Abebe

🔭 Future Features

• [Desktop vesrsion]
• [create functional toggler]

(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, kindly give me a ⭐️

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse and Gregoire Vella for design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)