📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👤 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support

• 📝 License

📖 Budget App

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

The Recipe App was built with:

• Ruby On Rails
• PostgreSQL

Tech Stack

• Rails
• PostgreSQL
• Bootstrap
• JavaScript

Key Features

• Authentication
• Table Logic

Live Demo

Live Demo

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Ruby 3.2.1 or later
• Rails 7.0 or later
• PostgreSQL

After installing Ruby, run the following command to install rails.-

 gem install rails

Setup

• Clone this project on your local machine using the following command in your terminal:

• Make sure to add .env file on your root directory and setup your .env file with your postgres username and password!

  git clone https://github.com/Zainab-Alzubair/RoR-budget-app.git
  bundle install
  rails s

Install

Run the following command to install all project's dependencies:

  cd recipe-app
  bundle install
  node install

Running the app

rails db:create:all rails db:migrate rails db:seed ### to populate the database with some sample data. rails s ## to start the server. http://localhost:3000 ## app link in the browser

Usage

bundle install

Next setup your .env so that you can create your dbs. Then:

rails db:create

rails db:migrate

rails db:seed

rails c --> To run rails console

rails s --> To run rails server

Run tests

• Make sure to add data to the test db or create dummy data on the test files inside rspec folder.

bundle install

rspec spec

👤 Author

👤 Zainab

• GitHub: Zainab-Al-Zubair
• LinkedIn: LinkedIn

🔭 Future Features

• implement some UX improvements: include transitions and/or animations, etc.
• A decent desktop design for the webapp.
• Implement the left side menu to improve the navigability of the app

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project, kindly give it a star ⭐️

🙏 Acknowledgments

• Microverse for providing the education that inspired this project.
• RailsGuides for the excellent documentation on Ruby on Rails.
• Gregoire Vella for the original design idea on Behance.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

(back to top)