Skip to content

Microverse-Fullstack-Program/rails-recipe-app-v3

 
 

Repository files navigation

📗 Table of Contents

📖 [Recipe App]

Recipe App is a web application that allows users to create and share recipes with other users. Users can create an account, log in to the app, and then create, edit, and delete their recipes. Also, users can add foods and set the recipes public or private. Moreover, users can also view public recipes created by other users.

🛠 Built With

Tech Stack

Client

Key Features

  • Login and Signup pages
  • Use of active record models
  • Add food, recipe, ingredients
  • View recipes, foods, and general shopping list

(back to top)

💻 Getting Started

To get a local copy and running, follow these steps.

Setup

Clone this repository to your desired folder by following the below steps

  • Create a local directory where you can clone the project
  • Clone the project to your directory by running
  git clone https://github.com/ybadr99/recipe-app
  • cd recipe-app

Prerequisites

In order to run this project you need Ruby and Ruby on Rails installed on your machine.

In addition, you need the following tech stack

  • Ruby on rails
  • npm
  • PostgreSQL
  • rails RSpec
  • Bootstrap
  • Devise for authentication
  • CanCanCan for authorization

(back to top)

Install

Install this project with:

1) cd 'project name'

2) "npm i" to install all dependencies

3) "bundle install" to install all gems

4) "rails s" to run the server

Run tests

  • "rspec" to run the tests

(back to top)

👥 Authors

👤 Chere Lemma

👤 Yousef Badr

(back to top)

🔭 Future Features

  • [Improve the UX]
  • [Add responsiviness]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

  • If you like this project kindly leave a Star

(back to top)

🙏 Acknowledgments

  • I would like to thank Microverse for giving me the opportunity to work in this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 65.5%
  • HTML 31.8%
  • JavaScript 2.1%
  • SCSS 0.6%