aeh1707/recipe_app

📗 Table of Contents

• 📗 Table of Contents
• Recipes App
  • Built With
    • Tech Stack
    • Key Features
  • Getting Started
    • Prerequisites
    • Setup
    • Available Scripts
  • Authors
  • Future Feature
  • Contributing
  • Show your support
  • Acknowledgments
  • License

Recipes App

Recipes App is web app that allow users to add food and create recipes, the app is built with Ruby on Rails and has a user authentication and an authorization system.

Built With

Tech Stack

• Ruby 3.1
• Ruby on Rails 7
• PostgreSQL 15

Key Features

• User registration system (using Devise gem)

Getting Started

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

Prerequisites

• Ruby
• Ruby on Rails
• PostgreSQL
• any code editor

Setup

To setup the project follow the steps:

1. Clone this project using Git Bash:

   git clone git@github.com:aeh1707/recipe_app.git 
   

2. Inside the project directory, install the project's dependencies

   bundle install
   

3. Setup the app's database

   rails db:setup
   

Available Scripts

In the project directory, you can run:

• rails server
  

  Runs the app server

• rubocop
  

  Launches the test runner.

Authors

👤 Sajeel Zafar

• GitHub: @Sajeelzafar
• Twitter: @SajeelZafar6
• LinkedIn: Sajeel Zafar

Future Feature

• Implement user engagement features (likes, comments and ratings)

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project give it a star!

Acknowledgments

• Microverse

License

This project is MIT licensed.