Recipe Application

📗 Table of Contents

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

📖 Recipe Application

Recipe App is project built with Rails and it's basically simple CRUD website, it has some features, such add creating, reading, updating and deleting features.

🛠 Built With

Tech Stack

Client

• Rails

Database

• PostgreSQL

Key Features

• Creating Recipes
• Creating Foods
• Reading Recipes
• Adding Ingredients
• Generating shopping list

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

• To have Ruby installed
• To have Rails 7 installed also
• Dependencies for basic gems that project uses

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/AbdelazizSoliman/Recipe_App_Capstone.git

Install

Install this project with:

  cd my-project

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

• For eslint run the following:

  rubocop

• For Stylelint(CSS) run the following:

  npx stylelint "**/*.{css,scss}"

• For testig run the following:

  rspec

Deployment

You can deploy this project using:

• Heroku etc.

(back to top)

👥 Authors

👤 Author1

👤 Abdelaziz Soliman

• GitHub: Abdelaziz
• LinkedIn: Abdelaziz

👤 Author2

👤 ALEX NG'ANG'A WAWERU

• GitHub: Alex
• LinkedIn: Alex

(back to top)

🔭 Future Features

• Updating Recipes

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you encounter any issues or have questions about the project, feel free to reach out for support. Provide information on how users can contact you, such as through email, a dedicated support channel, or by raising issues on GitHub.

(back to top)

🙏 Acknowledgments

I would like to express my heartfelt appreciation to Microverse for helping doing such projects, it's building our mindS and I am thankfully appreciating their efforts for heliping doing these tasks.

📝 License

This project is MIT licensed.

(back to top)