Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.97 KB

README.md

File metadata and controls

49 lines (35 loc) · 1.97 KB
Raw

Local Eats Backend Capstone Project

Welcome to the Local Eats Backend repository! This README file provides an overview of our backend application, its features, and instructions for setting it up and running it locally.

Table of Contents

Introduction

The Local Eats Backend is the heart of our platform, responsible for handling requests from the frontend, managing data, and facilitating the communication between users and our database. It plays a crucial role in delivering a seamless experience to both food enthusiasts and local cooks.

Features

1. Authentication

  • User registration and login using Google authentication.
  • Secure and token-based authentication system.

2. Meal Management

  • Create, update, and delete meal listings.
  • View and filter meals based on various criteria.
  • Store and retrieve meal data in MongoDB using Mongoose.

3. User Profiles

  • Create and manage user profiles.
  • Store and retrieve user data, including preferences and order history.

4. Email Notifications

  • Send transactional emails to users using Nodemailer.
  • Keep users informed about order updates and account activity.

5. API Documentation

  • Comprehensive API documentation using Swagger.
  • Easily understand and interact with the API endpoints.

Technologies Used

Our backend application is built using the following technologies:

  • Node.js: The runtime environment for the backend server.
  • Express.js: A web application framework for Node.js, ensuring efficient routing and handling of HTTP requests.
  • MongoDB: A NoSQL database for storing and managing data.
  • Mongoose: An elegant MongoDB object modeling tool for Node.js.
  • Firebase: Used for authentication and real-time features to enhance the user experience.
  • Nodemailer: For sending transactional emails and notifications.
  • Swagger: For clear and comprehensive API documentation.