karlavdelgadof / PlanB-app

This repo holds a mobile web application built with ROR where users can manage their budget: you have a list of transactions associated with a category so that users can keep track of their expenses.

PlanB App 📲🏦💸📝

📗 Table of Contents

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

📖 [PlanB]

This repo holds a mobile web application built with ROR where users can manage their budget: you have a list of transactions associated with a category so that users can keep track of their expenses.

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• Ruby

Server

• Rails

Database

• PostgreSQL
• 

Other

• GitHub flow
• Rubocop
• Stylelint

Key Features

• [Create category to group transactions]
• [Create transaction with multiple categories]

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

• Check the Ruby version or if you have at all by running ruby -v if it returns ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) or similar, you have Ruby installed.

• Ruby version used ruby 3.1.2

Setup 🛠️

Clone this repository to your desired folder:

• Clone the repository using the GitHub this link 🔗
• cd Plan-app

Install 📥

To get this project running correctly, please run the following command to install all necessary dependencies:

• Run bundle install

Usage

To run the project, execute the following command:

• Run rails server
• Open Browser http://localhost:3000/
• Ensure you have PostgreSQL installed before running the applicationpsql --version.
• Run rails db:setup.
• Create a .envs file using the link to host postgres credentials.

Run tests ⛔

To run tests:

• Ensure you have RSpec installed: running bundle install will install it since it is included in the Gemfile.
• To run a specific test:
• Run rspec spec/models<name_of_spec_file>
• To run all tests:
• Run rspec spec

(back to top)

👥 ✍️ Authors

👩‍💻 Karla Delgado ✍️

• GitHub: @karlavdelgadof
• Twitter: @karlavdelgadof
• LinkedIn: Karla Delgado

(back to top)

🔭 Future Features

• [Allow user to upload avatar]

(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 or find it useful/interesting, please make sure you give ⭐️ a since this will make it easily accesible for you too!

(back to top)

🙏 Acknowledgments

This work is licensed under a Creative Commons Attribution 4.0 International License.

(back to top)

📝 License

This project is MIT licensed.

(back to top)