Skip to content

SCORLEOs773/Recipe-Book

Repository files navigation

The Food Book

The Food Book is a web application built with Angular that helps users manage their recipes and shopping lists. It offers features for creating, editing, and deleting recipes, as well as managing ingredients and shopping items. The application provides a seamless experience for organizing meals and grocery shopping.

Links

The Food Book Project Website

Table of Contents

About

The Food Book is designed to simplify meal planning and grocery shopping for users. It offers a user-friendly interface and intuitive features for managing recipes and shopping lists. The application is built with Angular, a powerful front-end framework, and uses Firebase Realtime Database for data storage.

The Food Book aims to revolutionize the way users organize their culinary life by providing a comprehensive platform for recipe management and shopping list organization. With its user-centric design and robust functionality, The Food Book empowers users to take control of their meal planning process effortlessly.

Features

User Authentication

The application provides secure user authentication, allowing users to sign up for new accounts or log in with existing credentials. Authentication is handled using Firebase Authentication, ensuring user data remains protected.

Recipe Management

Users can create, edit, and delete recipes within the application. Each recipe includes details such as name, description, image, and ingredients. Users can easily navigate through their recipes and view recipe details with a single click.

Shopping List Management

The Food Book allows users to add ingredients from recipes directly to their shopping lists. Users can then view and manage their shopping lists, including adding, editing, and deleting items as needed. Shopping lists help users keep track of necessary ingredients for meal preparation.

Data Storage

User recipes and shopping lists are securely stored using Firebase Realtime Database. This cloud-based database ensures that user data remains synchronized across devices and accessible from anywhere. Data is stored in JSON format, making it easy to retrieve and manipulate.

Responsive Design

The application is designed with a responsive layout, ensuring optimal viewing and interaction across various devices and screen sizes. It includes different views and layouts specifically tailored for smaller screens and mobile devices. The responsive design ensures a seamless user experience regardless of the device being used.

Installation

To run The Food Book locally on your machine, follow these steps:

  1. Clone the repository to your local machine:
git clone https://github.com/your-username/your-repository.git

Usage

Once the application is running, users can perform the following tasks:

  • Sign up for a new account or log in with existing credentials.
  • Navigate through recipes using the navigation bar.
  • View details of individual recipes by clicking on them.
  • Add ingredients from recipes to the shopping list.
  • Manage the shopping list by adding, editing, or deleting items.
  • Log out from the application when finished.

Contributing

Contributions to The Food Book are welcome! To contribute, follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch from the main branch for your changes.
  3. Make your modifications and commit them to your branch.
  4. Push your branch to your forked repository.
  5. Submit a pull request to the main branch of the original repository.

Please follow the code formatting and style guidelines, and ensure that your changes are well-documented.

License

The Food Book is distributed under the MIT License.