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

📖 My awesome budget app

Simple and handsome app to manage your budget (create expenses, categories), with cute UI and intuitive UX. Built using Ruby on Rails, Postgres and Bootstrap.

(back to top)

🛠 Built With

Built with Ruby on Rails

Tech Stack

Client

• Ruby on Rails

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Sign up / log in users.
• Create categories.
• Display categories.
• Create transactions per category/categories.
• Display transactions per category/categories.

(back to top)

🚀 Live Demo

• Live Demo

• Video

(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, Rails and a Database such as PostgreSQL

Setup

Clone this repository to your desired folder:

  git clone [email protected]:Camilovelag/my-awesome-budget-app.git
  cd my-awesome-budget-app

Install

Install this project with:

Run the following commands, to be able to use Bootstap and JavsScript. If overwrites, type y

  rails javascript:install:esbuild
  rails css:install:bootstrap

Then run:

  bundle install
  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Run tests

To run all tests, including unit and integration tests, run the following command:

  rspec

(back to top)

👥 Author

👤 Camilo Vela

• GitHub: @camilovelag
• Twitter: @camilovelag
• LinkedIn: camilovelag

(back to top)

🔭 Future Features

• Group transactions per month.
• Add transaction details.
• Add modify/delete features for categories/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 please give it a ⭐️!

(back to top)

🙏 Acknowledgments

All the design credits go to Gregoire Vella on Behance. Thank you to microverse for setting us on this journey.

(back to top)

📝 License

This project is MIT licensed.

(back to top)