README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 📝 License

📖 [Recipe App]

The Recipe app keeps track of all your recipes, and ingredients. It allows you to save ingredients, keep track of what you have, create recipes, and generate a shopping list. Recipe app is uilt on Rails using Rubygems; authenticates using Devise and authorizes using CanCanCan.

🛠 Built With

Tech Stack

Client

• ERB Templating Engine

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Register a user]
• [Login a user]
• [Create ingredients]
• [Create Recipes]
• [Generate shopping list]
• [Add Ingredients to a recipe]
• [View Public Recipes]

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

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/arabiu033/recipes_app.git

Install

Install this project with:

  cd recipe-app
  bundle install

Usage

To run the project, execute the following command:

  rails server

(back to top)

👥 Authors

👤 Aminu Rabiu

• GitHub: Aminu Rabiu
• LinkedIn: Aminu Rabiu

👤 Muokwugwo Okechukwu

• GitHub: Muokwugwo Okechukwu
• LinkedIn: Muokwugwo Okechukwu

(back to top)

🔭 Future Features

• [Add categories for recipes]
• [Add photos for recipes]
• [SAdd comment section]

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

(back to top)

📝 License

This project is MIT licensed.

(back to top)