Agetuni/Budget_RailsApp

The Ruby on Rails Budget App is a mobile web application where you can manage your budget. For that, you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

📗 Table of Contents

Click to view contents

1. 📖 About the Project
   • 🛠 Built With
     • Tech Stack
     • Key Features
2. 💻 Getting Started
   • Prerequisites
   • Install
   • Usage
   • Deployment
3. 👥 Author
4. 🤝 Contributing
5. ⭐️ Show your support
6. 🙏 Acknowledgements
7. ❓ FAQ
8. 📝 License

📖 Budget App with Ruby on Rails

Budget App with Ruby on Rails 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

Server

• Ruby on Rails

Database

• PostgreSQL

Video Presentation

Video Demo Link

Live Demo (Render.com)

Live Demo Link

Key Features

• Allows register of new users and log in, so that the data is private to them.
• Allows the creation of categories of expenses by user.
• Allows the introduce of transactions associated with a category.
• It's possible to see the money spent on each category

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Ruby
• Rails
• Postgresql

Github

• Enter this url: https://github.com/cmolinan/Budget_RailsApp in your web browser.
• Once opened navigate to the top left level of the project a green code download button will be visible on the righthand side.
• Select the download Zip option from drop-down menu.
• Once the download is complete you will be able to access my project locally.

Local (Terminal)

  git clone https://github.com/cmolinan/Budget_RailsApp.git

Install

Install this project with the steps below:

• After cloning type cd Budget_RailsApp to access the project on the terminal.

• Run bundle install to install all the required dependancies.

• Run npm install to install other required dependancies.

• For developmente environment:

  • Create Database with rails db:create
  • Migrate Database with rails db:migrate
  • Populate data with rails db:seed

• For testing porpouses:

  • Create Database with rails db:create RAILS_ENV=test
  • Migrate Database with rails db:migrate RAILS_ENV=test

Usage

To run the project, execute the following command:

• Run rails s to start a development server.
• Use any of this users to log-in:
  • e-mail: tom@m.com / password: 666666
  • e-mail: mark@m.com / password: 666666

To run the tests of the project, execute the following command:

• Run rspec to start the tests

👥 Author

• GitHub: Carlos Molina
• LinkedIn: Carlos Molina

(back to top)

🤝 Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue, feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project. Don't forget to give it a ⭐️

(back to top)

🙏 Acknowledgments

• This webpage is based on an original Behance design, posted by Gregoire Vella https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding

(back to top)

❓ FAQ

• What inspired me to create this project?

  • The inspiration for this project came from microverse – a software development bootcamp where you work with teammates remotely on different projects.

(back to top)

📝 License

This project is MIT licensed.

(back to top)