- 📖 About the Project
- 🛠 Built With
- Key Features
- Future Features
- 💻 Getting Started
- Setup
- Prerequisites
- Usage
- 👥 Authors
- 🤝 Contributing
- ⭐️ Show Your Support
- 📜 License
Welcome to the Recipe App, a Ruby on Rails-based application designed to simplify your recipe management process. This application allows users to save and organize ingredients, manage their inventory, create new recipes, and generate shopping lists based on available ingredients and missing items. Additionally, the app supports recipe sharing, enabling users to make their culinary creations public for others to discover.
This project is built using Ruby on Rails, a robust web framework known for its simplicity and efficiency. Ruby on Rails provides a solid foundation for creating dynamic and user-friendly web applications.
- User-friendly interface for seamless recipe management.
- Ingredient tracking and inventory management system.
- Recipe creation, editing, and deletion capabilities.
- Shopping list generation based on available ingredients and missing items.
- Public and private recipe options for sharing and privacy.
- Responsive web design for optimal user experience.
- Comprehensive error handling and validation.
Note: Each feature will be marked with an "x" when it is fully implemented and functional.
- Advanced search functionality for finding specific recipes and ingredients.
- User profiles with customizable avatars and preferences.
- Integration with external APIs for ingredient information and recipe suggestions.
- Meal planning features, including weekly menus and scheduling.
- User ratings and reviews for shared recipes.
- Social media sharing options for recipes and cooking experiences.
To get started with the Recipe App, follow the instructions below:
-
Clone the project repository:
git clone https://github.com/PabloBona/recipe-app.git
-
Navigate to the project folder:
cd recipe-app
Before you can run the Blog App, make sure you have the following prerequisites and configurations in place:
-
Ruby: Ensure that Ruby is installed on your machine. You can check if it's installed by running
ruby -vin your terminal. If it's not installed, you can download and install it from the official Ruby website. -
Ruby on Rails: You'll need the Ruby on Rails framework installed. If you don't have it yet, you can install it using the following command:
gem install rails -
Code Editor: You should have a code editor like Visual Studio Code (VSCode) installed. You can download VSCode from the official website.
-
Git: Git is essential for version control. Make sure you have Git installed and configured on your system. You can download Git from the official Git website.
-
PostgreSQL: Ensure that PostgreSQL is installed and properly configured on the server where you are developing the project. This project assumes the use of PostgreSQL as the default database. You can download PostgreSQL from the official PostgreSQL website.
-
Ruby on Rails Configuration: Make sure your Ruby on Rails project is configured to use PostgreSQL as the default database.
With these prerequisites and configurations in place, you'll be ready to set up and run the Blog App.
Follow these steps to use the Blog App:
Open your terminal.
Navigate to the directory where the project files are located:
Copy code
cd /path/to/your/project/filesStart the Rails server:
Copy code
rails serverOpen your web browser and go to http://localhost:3000 to access the Blog App.
👤 Andrea Manuel
- GitHub: @AndreaM2429
- LinkedIn: LinkedIn
👤 Pablo Bonasera
- Github: @PabloBona
- Linkedin: Pablo Bonasera
Contributions, issues, and feature requests are welcome! Feel free to check the issues page and contribute to the project.
If you find this project helpful, consider giving it a ⭐️ to show your support!
This project is MIT licensed.