Yukino2002 / Foodies

This project is a recipe-sharing app that allows users to view a wide variety of recipes from all around the world. Users can also post their own recipes, like and comment on other recipes, and create a personalized dashboard to save their favorite recipes.

Foodies

Discover, share, and savor global flavors with our recipe app!

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is a recipe-sharing app that allows users to view a wide variety of recipes from all around the world. Users can also post their own recipes, like and comment on other recipes, and create a personalized dashboard to save their favorite recipes. Additionally, the app integrates with Twilio to enable users to receive recipes offline via SMS. This feature allows users to access their favorite recipes even when they do not have access to the internet.

(back to top)

Built With

• React - Used as the frontend framework for building user interface components.
• Firebase - Used as the backend service for data storage, user authentication, and hosting.
• Twilio API - Integrated with the app to enable offline recipe access via SMS.
• Material UI - Used for styling the app components and creating a consistent design.
• Express - Used as the server-side framework for handling HTTP requests and routing.
• Node.js - Used as the JavaScript runtime environment for building the server-side components of the app.

(back to top)

Getting Started

Before getting a local copy up, you must ensure that you have the necessary software required.

Prerequisites

• Node.js

    https://nodejs.org/en/download/

• Firebase project

    https://firebase.google.com/

Installation

1. Clone the repo

   git clone https://github.com/Yukino2002/Foodies.git

2. Install NPM packages

   npm install

3. Create auth.js in the src/database directory, and enter your Firebase config in auth.js

   const firebaseConfig = {
        apiKey:
        authDomain:
        projectId:
        storageBucket:
        messagingSenderId:
        appId:
        measurementId:
    }

4. Run the following code to set up the server for sending messages through twilio

   cd server
   npm install
   

5. Create a file named .env in the server directory and replace it with the below code

   TWILIO_ACCOUNT_SID=YOUR_ACCOUNT_SID
   TWILIO_AUTH_TOKEN=YOUR_AUTH_TOKEN
   TWILIO_PHONE_NUMBER=YOUR_TWILIO_PHONE_NUMBER
   

6. Run the server

   npm start
   

7. Run the app

   cd ..
   npm start

(back to top)

Usage

Demo Links

• Website
• Tutorial video

(back to top)

Roadmap

• Video integration - Support recipe videos uploaded by users or integrated from platforms like YouTube or Vimeo.
• User profile customization - Allow users to personalize their profile pages with pictures, bios, and information.
• Translation support: Allow users to translate recipes into their preferred language.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Pratik Jallan - [e-mail]

Malavika Harikumar - [e-mail]

Project Link: https://github.com/Yukino2002/Foodies

(back to top)

Acknowledgments

• Design Ideas
• Logo
• Best-README-Template

(back to top)