Skip to content

Game-Developers-Platform/Web-Game-Developers-Platform-Backend

Repository files navigation

Web Game Developers Platform Backend

Welcome to the Web Game Developers Platform Backend repository! This Node.js-based backend application provides the server-side functionality for the Web Game Developers Platform, including API endpoints for game management, user authentication, and more.

Table of Contents

Project Overview

The Web Game Developers Platform Backend is a RESTful API built with Node.js and Express. It handles requests from the frontend application, manages data persistence with MongoDB, and ensures secure user authentication using JWT.

Features

  • API Endpoints: Comprehensive API for managing games, user profiles, and authentication.
  • Authentication: Secure login and registration using JWT for token-based authentication.
  • Database Integration: Connects to MongoDB for storing user and game data.
  • CRUD Operations: Create, read, update, and delete operations for games and user profiles.
  • Environment Configuration: Configurable settings through environment variables.

Installation

To get started with the backend project, follow these steps:

  1. Clone the repository:

    cd Web-Game-Developers-Platform-Backend
    
  2. Navigate to the project directory:

    cd Web-Game-Developers-Platform-Backend
    
  3. Install Dependencies:

    npm install
    
  4. Create a .env file for environments variables:

    PORT=5000
    MONGODB_URI=mongodb://localhost:27017/mydatabase
    JWT_SECRET=your_jwt_secret
    
  5. Start the server:

    npm start
    

Usage

  • API Documentation: Use tools like Postman or Swagger to interact with and test the API endpoints.
  • Base URL: The base URL for API requests is http://localhost:5000/api.

Configuration

  • Environment Variables: Configure the following environment variables in your .env file:

    PORT=5000
    MONGODB_URI=mongodb://localhost:27017/mydatabase
    JWT_SECRET=your_jwt_secret

    Adjust PORT, MONGODB_URI, and JWT_SECRET as needed.

Testing

  • Unit Tests: Place your unit tests in the tests directory. These tests should cover various parts of your application to ensure its functionality and reliability.

  • Running Tests: To run the test suite, use the following command:

    npm test

License

This project is licensed under the MIT License.

About

Backend for the final project in "React Web Applications Course"

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors