📗 Index

• 📖 About the Project
  • 🛠 Built With
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Testing
  • Usage
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Food App] [Ruby On Rails]

The Ruby on Rails Food app exemplifies MVC architecture, using Devise for authentication and CanCanCan for authorization. It seamlessly interacts with a database, offering a user-friendly interface for food, recipes, and inventory management. Users can add, edit, and delete items based on their roles. Unique features include personalized shopping lists and recipe sharing. Inclusive sharing encourages culinary collaboration. Overall, it showcases Ruby on Rails' power for dynamic, user-centric applications.

🛠 Built With

Tech Stack

Client

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• [MVC Pattern] Follows the MVC(Model, View, Controller) pattern which allows it to be easy to manage
• [Authentication] Counts with an authentication system using Devise Gem which allows the user to have an unique account with its own email and password, and also allows the user to edit its own profile
• [Migration of Database using Rails method] All the data storaged is actually being managed by a Database, and the migration of the database is being done using the rails method
• [Testing] All the views are being tested using RSpec and Capybara
• [Linters] It follows the rules of 2 very well knowed linters Rubocop & Stylelint, which helps to keep the code clean and easy to read
• [Gitflow] Used Gitflow as a workflow which allows to have a clean and organized version control

(back to top)

🚀 Preview

currently not available

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

sh To have ruby installed with the last version of rails

Setup

Clone this repository to your desired folder:

sh Run bundle install to install all the gems and dependencies

Usage

To run the project, execute the following command:

sh Executing the command 'rails s' will start the server of this RoR app

Testing

To run integration tests, you have to follow these steps:

sh Executing the command bundle install will install all the necessary dependencies to run the tests of this RoR app

sh To run all the tests, execute the command 'rspec'

sh To run tests by using rspec

Deployment

No deployment necessary

(back to top)

👥 Authors

👤 Muneeb UR Rehman

• GitHub: @muneeb3123
• Twitter: @Hafizabd4
• LinkedIn:[Linkedin] (https://www.linkedin.com/in/muneeb-rehman-01b6bb193/)

👤 Larry Villegas

• GitHub: @LarryIVC
• Twitter: @LarryVillegas
• LinkedIn: LinkedIn

🔭 Future Features

• [Responsive Design] Build a fully responsive design
• [Live Demo] Deploy the app in a live server
• [User Profile] Add a user profile page

(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, be pending on our profiles. We are open to listen your opinion!

(back to top)

🙏 Acknowledgments

We extend our heartfelt gratitude to the Microverse Team and our valued partners, whose collaboration and support have been instrumental in bringing this project to fruition.

(back to top)

📝 License

This project is MIT licensed.

(back to top)