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
• 📝 License

📖 [Recipe app]

[Recipe app] The 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. Built with Ruby on Rails.

🛠 Built With

Tech Stack

Client

• HTML
• CSS

Server

• Rails

Database

• PostgreSQL

Key Features

• [Models]
• [Controllers]
• [Views]

(back to top)

🚀 Live Demo

• render

(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 [email protected]:topeogunleye/recipe-app-rails.git

Install

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec spec/models/model_name_spec.rb

Deployment

You can deploy this project using: Coming Soon

(back to top)

👥 Authors

👤 Temitope Ogunleye

• GitHub: @topeogunleye
• Twitter: @tope_leye
• LinkedIn: ogunleye

👤 Adel Guitoun

• GitHub: @adel-gu
• Twitter: @GuitounAdel
• LinkedIn: adelguitoun

👤 Desta Legesse Wubishet

• GitHub: @dlwub
• Twitter: @DestaWubishet
• LinkedIn: desta-legesse-w-509844213

(back to top)

🔭 Future Features

• [Tailwind CSS]
• [Models]
• [Authentication with Devise]

(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 on GitHub

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me this project to build

(back to top)

❓ FAQ

• [What was the most intrigging concept you learnt whilst building this project]

  • [Model, View, Controllers]

• [How long did you use to build this project]

  • [The length of the project is 2 weeks and three days]

(back to top)

📝 License

This project is MIT licensed.

(back to top)