README.md

Budget-app

📗 Table of Contents

• 📖 About the Project
• Walkthrough video 🎥
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 About the Project

Budget App is 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

Client

• Ruby on Rails

Databases

• PostgreSQL

Key Features

• Contains data about users
• Contains data about posts

(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:

• An IDE (ex: VS Code)
• Github account

Setup

Clone this repository to your desired folder:

  cd project-folder
  git clone git@github.com:JavierAybar/Budget-app.git

Install

Install this project with webpack:

  cd project-folder
  bundle install
  rails db:setup

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec spec

Compile Tailwind CSS:

  rails tailwindcss:build

Deployment

You can deploy this project using GitPages:

• Go to github.com
• Create a new repository
• Add all website files in the new repository
• Go to Settings/Pages
• Go to branch and change from 'none' to 'main'
• Click Save

(back to top)

Walkthrough video 🎥

Link

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

👥 Authors

👤 Javier Aybar

• GitHub: @JavierAybar
• LinkedIn: @JavierAybar

(back to top)

🔭 Future Features

• More data
• More query

(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 and wish to collaborate. Please contact us.

(back to top)

🙏 Acknowledgments

Special thanks to Gregoire Vella from providing us with an excellent resource from their Behance account. Also, I would like to thanks to my family members for supporting me during Microverse, and their team.

(back to top)

❓ FAQ

• Is it responsive?

  • Yes, works both on mobile and desktop.

(back to top)

📝 License

This project is MIT licensed.

(back to top)