vodz1 / freshmate_back

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Freshmate Backend

Welcome to the backend repository for Freshmate! This backend server is built using Node.js to provide the necessary APIs for the Freshmate ecommerce website frontend.

Table of Contents

  1. Introduction
  2. Features
  3. Installation
  4. Usage
  5. Frontend Repository
  6. Contributing
  7. License

Introduction

The Freshmate backend is designed to handle various functionalities required by the frontend application, including user authentication, product management, and order processing. It provides RESTful APIs that communicate with the frontend to ensure seamless interaction with the database and other services.

Features

  • User Authentication: Secure endpoints for user registration, login, and authentication.
  • Product Management: CRUD operations for managing products and categories.
  • Order Processing: APIs for creating, updating, and retrieving orders.
  • Middleware Integration: Utilizes middleware for error handling, authentication, and request validation.

Installation

To run the Freshmate backend locally, follow these steps:

  1. Clone this repository to your local machine.
  2. Navigate to the project directory in your terminal.
  3. Install dependencies by running npm install.
  4. Create a .env file in the root directory of the project.
  5. Add the following environment variables to the .env file: PORT=8000 MONGODB=<your_mongodb_connection_string> TOKEN_SECRET=<your_token_secret> Replace <your_mongodb_connection_string> with your MongoDB connection string and <your_token_secret> with a secret key for JWT token generation.
  6. Start the server by running npm run watch.
  7. The server will be running on port 8000 by default.

Usage

Once the backend server is running, it will be ready to handle requests from the Freshmate frontend application. Ensure that the frontend application is configured to communicate with the backend server (e.g., update API URLs).

Frontend Repository

The frontend for Freshmate is hosted in a separate repository. You can find it here.

Contributors ✨

Omar Ahmed
Omar Ahmed
Esraa Ahmed
Esraa Ahmed
Salma Yousry
Salma Yousry
Mostafa Fakhr
Mostafa Fakhr
Karim Mohamed
Karim Mohamed
Ahmed Adel
Ahmed Adel

License

This project is licensed under the MIT License.

About


Languages

Language:JavaScript 100.0%