Al-Amin-Khan-Shakil/food-recipe

Food Recipe

📗 Table of Contents

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

📖 Food Recipe

Food Recipe is a Rails application for managing a food recipes and accompanying ingredients.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Display FOODS
• CRUD for FOOD
• Display Public & Private Recipes
• CRUD for Recipes
• General Shopping List

(back to top)

🚀 Live Demo

• Coming soon

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

 Ruby
 gem install rails
 IDE
 Browser

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Al-Amin-Khan-Shakil/food-recipe.git

Install

Install this project with:

  bundle install

Usage

To run the project, execute the following command:

  rails s

Run tests

To run tests, run the following command:

  rspec spec

(back to top)

👥 Authors

👤 Al Amin Khan Shakil

• GitHub: Al Amin Khan Shakil
• Twitter: Al Amin Khan Shakil
• LinkedIn: Al Amin Khan Shakil

👤Al Amin Khan Shakil

• GitHub: Samuel Wanza
• Twitter: Samuel Wanza
• LinkedIn: Samuel Wanza

(back to top)

🔭 Future Features

• CreateUserProfile
• RecipeRecommendations
• RecipeTutorials

(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, please give it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Al Amin Khan Shakil that ensured we implemented this project within the give timelines and requirements.

(back to top)

❓ FAQ (OPTIONAL)

• Can I contribute to this project?

  • Yes, you can. You can fork you modification on this project. If it gets approval then we will merge your changes.

• What knowledge Should I have to create a project like this?

  • You should have basic RubyONRails Knowledge.

(back to top)

📝 License

This project is MIT licensed.

(back to top)