Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.02 KB

README.md

File metadata and controls

68 lines (43 loc) · 2.02 KB

Project Backend - Student Club Management System

Description

This project's backend is a RESTful API that manages student clubs and students, and connects to a MongoDB database. The backend is responsible for handling all data processing and storage, and communicates with the frontend to provide a seamless user experience. Users can interact with the system to create, read, update, and delete information about clubs and students.

Features

  • CRUD operations for clubs and students
  • Secure authentication and authorization for users
  • Efficient and scalable MongoDB database connection
  • Real-time data synchronization between the frontend and backend

Prerequisites

  • Node.js v14.x.x or later
  • npm v7.x.x or later
  • MongoDB v4.4.x or later

Installation and Setup

  1. Clone the repository

    git clone https://github.com/your-username/student-club-management-backend.git
cd student-club-management-backend

  2. Install dependencies

    npm install

  3. Configure environment variables

    • Create a new .env file in the root directory of the project.
    • Add the following variables to the .env file, and replace the placeholders with the appropriate values:
    PORT=<port_number>
MONGODB_URI=<your_mongo_db_uri>
SECRET_KEY=<your_secret_key>

  4. Start the MongoDB server

    • Follow the instructions in the MongoDB documentation to install and start the MongoDB server on your local machine or remote server.

  5. Start the backend server

    npm start

    The server will now be running on the specified port (e.g., http://localhost:<port_number>).

API Documentation

  • For detailed API documentation, please visit http://localhost:<port_number>/api-docs once the server is running.

Contributing

License