Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 2.3 KB

README.md

File metadata and controls

83 lines (58 loc) · 2.3 KB

Online Workshop Server


3D Gear Spinning

About This Repository

This repository contains the backend server for the Online Workshop application, built to enable seamless real-time interactions, content delivery, and user management for online workshops.

Features

  • User Authentication: Secure login and registration.
  • Content Delivery: Management and distribution of workshop materials (PDFs, Docs).
  • Attendance System: Track and record student participation in workshops.
  • Admin & Faculty Dashboards: Specialized tools for system management and workshop instruction.
  • Automated Seeding: Automatic creation of default Admin and Faculty accounts.

Technologies Used

  • Java 17: Backend programming language.
  • Spring Boot 3.3.4: Framework for building REST APIs.
  • MariaDB: High-performance relational database storage.
  • Spring Data JPA: For database abstraction and ORM (Hibernate).
  • Maven: Project management and build tool.

Default Credentials

On application startup, the following accounts are automatically created for testing:

Role Username Password
Admin admin admin123
Faculty faculty faculty123

Setup Instructions

Prerequisites

  • Java 17 or higher installed.
  • MariaDB server running on localhost:3306.
  • Mysql change credentials in "application.properties".

Running Locally

  1. Clone the repository:

    git clone https://github.com/udaykiriti/OnlineWorkshopServer.git
cd OnlineWorkshopServer

  2. Configure Database: The server is configured to connect to workshop_db. It will attempt to create the database automatically if it doesn't exist.

  3. Run the application:

    chmod +x mvnw
./mvnw spring-boot:run

The server will be available at: http://localhost:8081

API Base Endpoints

  • POST /api/auth/login - User authentication.
  • POST /api/auth/signup - New user registration.
  • GET /api/workshops - List all workshops.
  • GET /api/users/{username} - Fetch user profile.
  • POST /api/attendance/mark - Record attendance.