emhamza/rails-recipe-app

Rails Group Project

📗 Table of Contents

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

📖 Rails app: Recipe-App

• Fully Functional Recipe App with User Authentication and Testing Using Ruby on Rails and Devise Our project is a collaborative effort to develop a feature-rich recipe application built on the Ruby on Rails (ROR) framework. The primary goal of this application is to allow users to create, manage, and share their recipes while providing a seamless and intuitive user experience.

🛠 Built With

• Rails
• PostgrelSQL
• ROR

(back to top)

Key Features

• User Authentication
• Recipe Management
• User Profile
• Recipe Search and Filtering
• Recipe Rating and Comments
• User-Friendly UI

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Example command:

1.use a browser
2.use cable internet
3. rails routes --grep users

Setup

Clone this repository to your desired folder:

Example commands:

  git clone git@github.com:emhamza/rails-recipe-app.git
  cd my-blog

Install

Install this project with:

Example command:

bundle install

Usage

To run the project, execute the following command:

Example command:

- Open the terminal to play with the commands.

Run tests

To run tests for the linter, run the following command:

Example command:

rspec
bundle exec rspec spec/system

rubocop -A

(back to top)

👥 Authors

👤 Umair Hamza

• GitHub: @emhamza
• Twitter: @uhamzaz
• LinkedIn: Umair Hamza

👤 NALEDI DIKGALE

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn
• Website: https://naledi-dikgale.github.io/mobile-portfolio/

(back to top)

🔭 Future Features

• As an ambitious project, we have a roadmap for future enhancements. This includes incorporating advanced features such as recipe favoriting, meal planning, and social sharing. We also plan to implement additional testing, including performance testing and automated UI testing.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the Isuues Pages

(back to top)

⭐️ Show your support

If you like this project kindly give it a star⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the immense support.

(back to top)

📝 License

This project is MIT licensed.

(back to top)