📗 Table of Contents

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

📖 [Recipe App]

Recipe App is a web application that allows users to create and share recipes with other users. Users can create an account, log in, and create, edit, and delete their recipes. Users can also view recipes created by other users.

🛠 Built With

Tech Stack

Client

• Rails

Key Features

• Gitflow execution
• Login page
• Signup page
• Use of models
• Add food
• Add recipe
• View recipes
• View foods
• Add inventory
• View inventory

(back to top)

💻 Getting Started

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

Setup

• Clone this repository to your desired folder:

for cloning follow this steps

• Create a local directory where you can clone the project
• Clone the project to your directory by running https://github.com/ritikarawat220/Recipe-App.git
• Run the code with ruby

Example commands:

  git clone git@github.com:ritikarawat220/Recipe-App.git

Prerequisites

In order to run this project you need:

• Node.js
• npm
• ruby 2.7.0
• rails
• PostgreSQL

(back to top)

Install

Install this project with:

cd 'project name'

"npm i" to install all dependencies

"bundle install" to install all gems

"rails s" to run the server

Run tests

• "rspec" to run the tests

(back to top)

👥 Authors

👤 Ritika Rawat

• GitHub: ritikarawat220
• Twitter: @ritikarawat22
• LinkedIn: LinkedIn

👤 Jean Jacques Buhendwa

• GitHub: @jeanbuhendwa
• LinkedIn: Jean Jacques buhendwa
• Twitter: @JeanjacqueI

👤 Chere Lemma

• GitHub: Chere Lemma
• LinkedIn: Chere (Urgaya) Lemma
• Twitter: @Chere21271613

(back to top)

🔭 Future Features

• [Add better Navigation]
• [Better UX]

(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 leave a Star

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for giving me the opportunity to work in this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)