m-talbi/recipe-app

📗 Table of Contents

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

Recipe App

Recipe 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

Client

• HTML, CSS
• JavaScript

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User registration system (using Devise gem)
• User authorization system to manage permissions and access control (using CanCanCan gem)

Live Demo

• Check live version

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 https://github.com/Kweeka1/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

👤 Mohamed Talbi

• GitHub: @Kweeka1
• LinkedIn: Mohamed Talbi

👤 Selma Hamutenya

• GitHub: @SelmaNdapanda
• Twitter: @SellohBlaq
• LinkedIn: selma-hamutenya

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
• Code Reviewers

License

This project is MIT licensed.