📗 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

This project a functional Budget App created using Ruby on Rails. It allows user to create transactions with many to many relationship of categories, so that they can track their transaction history.

🛠 Built With

Tech Stack

• Rails
• PostgreSQL
• Bootstrap
• JavaScript
• RestAPI

Key Features

• Transactions
• Authentication and Authorization
• Table Logic
• Add Data to DB

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:

• IDE or code editor: VsCode, atom, sublime...
• To have Ruby and Git installed on your system.
• To have Node.js installed on your system.

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/Linushaddai99/Group-Recipe-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

👤 Mert Kaya

• GitHub: @mkaya13
• Twitter: @mkaya133
• LinkedIn: LinkedIn

🔭 Future Features

• Add GUI
• Add User Pages
• Add More Items
• Improve Items

🤝 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
• Ruby on Rails Documentation🙃
• Every person who inspired this codebase.
• Original design idea by Gregoire Vella on Behance with changes and updates Creative Commons license of the design

📝 License

This project is MIT licensed.

(back to top)

```