Skip to content

Latest commit

 

History

History
227 lines (154 loc) · 4.91 KB

README.md

File metadata and controls

227 lines (154 loc) · 4.91 KB

Recipe App

📗 Table of Contents

📖 Recipe App

Recipe App will allow you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them.

🛠 Built With

Tech Stack

Ruby
Ruby on Rails
Bootstrap 5
Database

Key Features

  • [Authentication, User can manage his recipies and foods]
  • [Guest User can navigate the App and read all ]

(back to top)

(back to top)

📇 Entity Relationship Diagram

er-diagram

💻 Getting Started

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

Prerequisites

In order to run this project you need:

  • Visual Studio Code
  • Git
  • Ruby
  • PostgreSQL
  • Rails
 gem install rails

Setup

Clone this repository to your desired folder:

https://github.com/OpondoG/RecipeApp.git
cd recipe-app 

Install

Install this project with:

  bundle install
  npm install

Create Database (Mandatory)

rails db:create

If you have made a migration then run this command

rails db:migrate
rails db:seed

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

rspec

(back to top)

👥 Authors

👤 Gilbert Okonjo

👤 Orji Maxwell

(back to top)

🔭 Future Features

  • [Use importmaps or esbuild for loading JavaScript]
  • [Build the API for recipes based on User entries]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc

(back to top)

📝 License

This project is MIT licensed.

(back to top)