Microverse README Template

📗 Table of Contents

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

📖 [Recipe App]

Describe your project in 1 or 2 sentences.

**[Recipe App]**keeps track of all your recipes, ingredients, and inventory. It 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 allows you to make them public so anyone can access them.

🛠 Built With

• Ruby
• Ruby on Rails
• Postgresql
• VScode

Tech Stack

• Ruby
• Ruby on Rails
• Postgresql
• Embedded Ruby

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Create a recipe]
• [Create foods that can be cooked using recipes]
• [Shopping List]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

This is an example of how you may give instructions on setting up your project locally. Modify this file to match your project, remove sections that don't apply. For example: delete the testing section if the currect project doesn't require testing.

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

Prerequisites

• A code editor (like Atom, VScode...).

Setup

To setup the project locally: clone the repository using:

[email protected]:Timbar09/recipe_app-rails.git

Install

run: rails server

Usage

Run tests

run: rspec

Deployment

login: localhost:3000

(back to top)

👥 Authors

👤 Ogaga Iyara

• GitHub: @githubhandle

• Twitter: @twitterhandle

• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [new_feature_1]
• [new_feature_2]
• [new_feature_3]

(back to top)

🤝 Contributing

CContributions, 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

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

(back to top)

❓ FAQ (OPTIONAL)

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)