Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 1.49 KB

README.md

File metadata and controls

57 lines (44 loc) · 1.49 KB

Collaborative Concurrent Document Editor

Overview

The Collaborative Concurrent Document Editor is a project consisting of several microservices developed in Spring Boot. It enables multiple users to collaborate on documents concurrently. The project includes services for user authentication, document management, and real-time editing.

Prerequisites

Before running the application, ensure you have the following installed:

  • Maven: Build tool (binary available in the git repository as well).
  • Java 21: Required to run the Spring Boot JAR files.
  • Docker: For containerization of services.
  • Node.js and npm: Needed for running the frontend client.

Running the Application

Each microservice is built as a separate Spring Boot project in Java. The following commands are used to build and run the services.

Backend (Spring Boot)

  • Build and download dependencies:

    mvn clean install

  • Compile the project:

    mvn compile

  • Run the Spring Boot application:

    mvn spring-boot:run

  • Create the JAR file for deployment:

    mvn package

  • Run the application from the JAR file:

    java -jar <jarfilename>.jar

  • Frontend (React): To run the frontend client, navigate to the frontend project directory and use the following commands:

    • Install required Node modules:
    npm install
    • Run the development server:
    npm run dev