/Recieps

This project involves building a web application with Ruby on Rails, implementing Devise for user authentication, and creating features such as a food and recipe list, public recipe list, and general shopping list with testing.

Primary LanguageRubyMIT LicenseMIT

📗 Table of Contents

📖 Recipe App

  • This project involves building a web application with Ruby on Rails, implementing Devise for user authentication, and creating features such as a food and recipe list, public recipe list, and general shopping list with testing.

(back to top)

🛠 Built With

Tech Stack

Key Features

  • User authentication with Devise
  • Food and recipe lists
  • Public recipe list
  • General shopping list view

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

  • To install ruby on rails on your PC. You can read this documentation on how to do so
  • Know how to navigate directories or folders at the CLI.
  • Know how to get a repository's URL(https/ssh) on GitHub.
  • You should have a code editor installed, preferably VSCode.

Setup

In the desired folder or directory in the CLI, run the command:

git clone https://github.com/RoyJumah/recipe-app.git

Navigate into the cloned folder or repository by running the command:

 cd recipe-app

If VsCode is your default code editor, run:

  code .

To install all the dependencies, run:

 bundle install

After installing all the dependencies with the bundle install command, run the command rails s to start the server, and then navigate to http://localhost:3000 in your web browser to access the application.

You are all set up!

(back to top)

Run tests

To run tests, run the following command:

  $ bundle exec rspec

(back to top)

👥 Authors

👤 Roy Jumah

👤 Hassaan Baig

(back to top)

🔭 Future Features

  • Ability to search for recipes
  • Integration with payment system for shopping list
  • Social sharing of recipes
  • User profile customization options

(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 you can give it a star

(back to top)

🙏 Acknowledgments

We want to thank Microverse for providing us with the resources that enabled us to finish this challenge!

(back to top)

📝 License

This project is MIT licensed.

(back to top)