BudgetPro

📗 Table of Contents

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

📖 BudgetPro

BudgetPro 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. You can see an introduction of this webpage in this video

🛠 Built With

Tech Stack

So you want to lear more about the tech we have used for this project?

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Make use for migrations features from Active Record
• Include Tables for User, Categories and Transactions

🚀 Live Demo

If you would like to see this site on action click on the link below:

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps. Note: We are assuming you have pre-installed ruby, WSL, ubuntu and rails!

Prerequisites

In order to run this project you need:

first at all, install rails:

 gem install rails

after that you have to install postgresql from official site then you can go to install part in below1

Setup

Clone this repository to your desired folder:

git clone https://github.com/najibullahjafari/BudgetPro

Install

Install this project with:

  bundle install
  npm install

Setting up the Data Base:

  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

Before running tests, ensure you've set up the test database:

bin/rails db:migrate RAILS_ENV=test

Note: Given that the aim of this project is to test the application's UI, to see if it works without side effects. We have therefore had to modify the contents of certain files, which could have the effect of falsifying certain Unit tests. We therefore recommend that, rather than running all the tests, you only test the features folder.

bundle exec rspec ./spec/features

(back to top)

Install

Install this project with:

  cd RoR-group-project
  bundle install

Setting up the Data Base:

  rails db:create
  rails db:migrate
  rails db:seed

👥 Authors

👤 Najibullah Jafari

• GitHub: Najibullah_jafari
• Twitter: Najibullah_jafari
• LinkedIn: Najibullah_jafari

(back to top)

🔭 Future Features

We this project can improve, we are planning to include the next features soon:

• User Interface
• Validations
• API documentation
• Model Data
• Controllers Testing
• Models Testing
• View Implementation
• User Interface
• Validations
• API documentation
• Model Data
• Controllers Testing
• Models Testing
• View Implementation
• Integration Testing
• Unit Testing

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Would you like to help?

If you like this project feel free to leave an star, as well if you have a suggestion feel free to visit issues page.

(back to top)

🙏 Acknowledgments

I would like to thank Gregoire Vella due to his effort with this great UI.

(back to top)

❓ FAQ (OPTIONAL)

Learn more about FAQ below:

• How do I fix Linters errors if I modify the project?

  • for rubocop run

  rubocop -A

  • for Stylint run:

  npx stylelint "**/*.{css,scss}" --fix

(back to top)

📝 License

This project is MIT licensed.

(back to top)