Recipe App

📗 Table of Contents

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

📖 Recipe app

RECIPE app is project built with Rails and it's actuallt simple app that users has an ability to add food recipes which he/she can make public or private.

🛠 Built With

Tech Stack

Client

• Rails

Database

• PostgreSQL

Key Features

• Adding food recipes
• Sing up
• Sing out

(back to top)

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

• 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/husush23/Recipe_app.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:

  bundle exec rspec

Deployment

You can deploy this project using:

• Heroku etc.

(back to top)

👥 Authors

👤 Author 1

👤 Hussein Hashi

• GitHub: Husush23
• Twitter: Hussein
• LinkedIn: Hussein

👤 Author 2

👤 Saloman

• GitHub: Tshobohwa
• LinkedIn: Tshobohwa

(back to top)

🔭 Future Features

• Single page app
• Complete webApp
• Smooth functionality(design)

🤝 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.Checkout teh socail links included in the authors, contact any of one or simply contribute this repo by raising a pull request on and always try to check the issues page.

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