📗 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
• 🙏 Acknowledgements
• 📝 License

📖 [DavRich Recipe App]

[DavRich Recipe App] is a full stack web app with which a user can publish recipes which can be viewed by anyone signed in or not signed in if the publisher declares the recipe as public. A publisher can add and remove ingredients and generate a shopping list for restocking on ingredients.

🛠 Built With Ruby on Rails

Tech Stack

Client

• HTML
• CSS

Server

• Ruby on rails

Database

• PostgreSQL

Key Features

• Authentication with devise
• Nested routing

(back to top)

🚀 Live Demo

• Live Demo Link [Under construction]

(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 installed
• npm installed
• A terminal
• A Web browser

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:amon-cofie/DavRich-Recipe-App.git
  cd DavRich-Recipe-App

Install

Install this project with:

  bundle install
  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

(back to top)

👥 Authors

👤 David Amon-Cofie

• GitHub: @amon-cofie
• Twitter: @amon_cofie
• LinkedIn: David Amon-Cofie

👤 Richard Chileya

• GitHub: @RichardChileya
• Twitter: @RichardChileya
• LinkedIn: Richard Chileya

(back to top)

🔭 Future Features

• Deployment
• Shipping to staging

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

(back to top)

🙏 Acknowledgments

We would like to thank all reviewers who helped improve the quality of our codebase

(back to top)

📝 License

This project is MIT licensed.

(back to top)