Recipe app

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe app Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Recipe app

Recipe app repo is a robust and user-friendly web application designed to empower individuals create and share their special recipe to the world.

🛠 Built With

Tech Stack

Technology

• Ruby - A high-level programming language used for back-end development.
• irb - A command line interface for ruby
• rails - A framework for building ruby web-applications

Tools

• VSCode
• Git

Key Features

• User authentication
• Users can add a recipe
• Users can decide to make a recipe public or private
• Users can generate a shopping list from a particular recipe

(back to top)

💻 Getting Started

Prerequisites

In order to reproduce the receipe-app and be able to make changes for your own purpose, you need the following tools:

• Visual Studio Code
• git-scm
• A Github account

Setup

Clone this repository to your desired folder by running the following command:

  git clone https://github.com/0sugo/recipe-app.git

Install

To use this application, you need to have ruby and rails gem installed on your machine. Once you have them installed,

Run bundle install to install all dependencies

  cd recipe-app
  bundle install

Once you have the files on your machine, you can view it on your browser on https://localhost:3000 by running

rails server

Run tests

To run model tests,run the following command:

rspec spec/models

To run integration tests,run the following command:

rspec spec/integrations

(back to top)

👥 Authors

👤 Spencer Okyere

• GitHub: @skabeo
• Twitter: @black_okyere
• LinkedIn: LinkedIn

👤 JOSECK OSUGO

• GitHub: 0sugo
• Twitter: @0sugo5
• LinkedIn Joseck Osugo

(back to top)

🔭 Future Features

• Infinite scrolling

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

If you would like to contribute to this project, you can follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Create a pull request back to the original repository.

(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 express my gratitude to the following individuals and organizations for their contributions to this project:

• GitHub: Platform for version control and collaboration
• Microverse: Global school for remote software developers

(back to top)

❓ FAQ

• How can I contribute to this project?

  • Contributions, issues, and feature requests are welcome! You can check the issues page to see if there are any current issues or feature requests that you can work on. If not, feel free to submit a new issue or pull request. Before contributing, please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)