📗 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 (OPTIONAL)
• 📝 License

📖 RECIPE APP

RECIPE APP is a full-stack application that can allow users to create accounts, login, add their different types of food and recipes, and to generate a shopping list for every recipe they have. The user can also have access to a 'public recipes' page without the need for logging in.

🛠 Built With

Tech Stack

Editor

• VSCODE Editor

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• The Blog allows to create users
• The users created need to authenticate to publish posts
• The users can make leave comments and likes for the posts

(back to top)

🚀 Live Demo

• Coming soon when the project is finished

Screenshots

Desktop

Mobile

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

• Basic knowledge of the command line.
• Ruby on Rails installed, you can follow this link.
• Postgresql Database, you can follow this link, choose your system & follow the provided instructions.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Peter1907/recipe-app.git

Install

Install this project with:

  cd recipe-app
  bundle install

Install tailwindcss gem to work properly:

  rails tailwindscss:install

Usage

To run the project, execute the following command:

• To run the project in your browser, run:

  rails server

Or for short:

  rails s

• if you want to modify styles & let tailwind compile on save run:

  rails tailwindcss:watch

Run tests

• You would have the necessary gems added to the Gemfile
• Open the terminal in the repo folder on your machine & run bundle install if you haven't already done so by this point
• In the terminal you have the option to run the tests for:
  • An entire folder, using the rspec spec command.
  • A sub-folder, using the rspec spec/models for example.
  • A single file, using the rspec spec/requests/post_spec.rb for example.

(back to top)

👥 Authors

👤 Hans Zizold

• GitHub:@githubhandle
• Twitter:@twitterhandle
• LinkedIn:LinkedIn

👤 Peter Beshara

• GitHub: @Peter1907
• Twitter: @Peter_Beshara_
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Deployment using Heroku

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• My loving family 😊
• My partners from Microverse
• Inspiration, Dedication

(back to top)

📝 License

This project is MIT licensed.

(back to top)