juandiegoguerra/ror_capstone-budget_app

The Ruby on Rails capstone project is about building 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.

Budget App

📗 Table of Contents

• 📗 Table of Contents
• 📖 Budget App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 🎨 Highlights
  • ❓ FAQ
  • 📝 License

📖 Budget App

The Mobile Budget app is about building 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

List of technologies used for this project

Client

• Ruby

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Create user LogIn and SignUp pages.
• Create Categories page.
• Create transaction page for each category.
• Add categories and transactions pages.
• Remove categories

(back to top)

🚀 Live Demo

Live Demo 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:

gem install ruby

• Browser (Google Chrome, Mozilla Firefox, Safari or any other browser)

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/JuanDiegoGuerra/RoR_Capstone-Budget_App.git

Install

Install this project with:

  cd Budget-app-rails
  bundle install

Usage

To run the project, execute the following command:

rails tailwindcss:watch
control + c 
rails s

Note: If there are any errors consider adding your necesary username and password in database.yml for setting up your local enviroment and use the following comand:

rails db:create db:migrate
rails s

Run tests

To run tests, run the following command:

rails tailwindcss:watch
control + c
rspec spec

(back to top)

👥 Author

👨🏼‍🚀 Juan Diego Guerra (JD) 👾

• GitHub: @JuanDiegoGuerra
• Twitter: @jdxelric147
• LinkedIn: Juan Guerra

(back to top)

🔭 Future Features

• Improve UI
• Add more functionality
• Add Desktop Version

(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

I would like to thank Microverse for giving me the opportunity to learn and grow as a developer and also I like to thank my family, they are all my support. 🌟

Original design idea by Gregoire Vella on Behance.

(back to top)

🎨 Highlights

I would like to highlight an interesting piece of code related to my project and it is the fact that I integrated Tailwind CSS for the styling of the app.

(back to top)

❓ FAQ

• Do I need to install any program before running this project?

  • Yes, you need to install Ruby
  
  

• Can I use this project for my own purposes?

  • Yes, you can.

(back to top)

📝 License

This project is MIT licensed.

(back to top)