Skip to content

Latest commit

 

History

History
162 lines (149 loc) · 7.06 KB

README.md

File metadata and controls

162 lines (149 loc) · 7.06 KB

💬 Real-time Q&A App with Spring Boot & React

  • Built with Spring Boot 3.4.4 and Amazon Corretto 21
  • Host Q&A sessions in real time – perfect for events, lectures, or live streams
  • ✨ Live question sync – Users can submit questions and see updates instantly via WebSocket (STOMP)
  • ✅ Question resolution tracking – Mark questions as answered to manage audience engagement
  • 🔗 Easy room sharing – Create a room and share the unique link or join using a room number
  • ⚡ Streamlined architecture – Clean separation of domain, service, and controller layers for rapid development

💻 Installation & Setup

  1. Check URL and Port

    1. Move your mouse pointer over the [Preview] → [Running URL and Port] button in the menu bar and click the button.
    2. Check running domains with 3000 port for frontend and 8080 port for backend.

  2. Environment variables and config settings

    1. Paste the front domain (which uses port 3000) into the front/.env file.

  3. Check dependencies

    1. front end dependency
      1. move to front directory (cd front)
      2. use npm install to install dependencies
    2. back end dependency
      1. move to back directory (cd back)
      2. use ./gradlew classes to install dependencies

  4. Run Project

    1. Click [Run QnA] in the menu bar
    2. Alternatively, run pm2 start ecosystem.config.js in the terminal directly

📂 Project Structure

front

.
├── README.md
├── package-lock.json
├── package.json
├── public
│   ├── index.html
│   ├── manifest.json
│   └── robots.txt
└── src
    ├── App.css
    ├── App.js
    ├── components
    │   ├── Button.jsx
    │   ├── Input.jsx
    │   ├── MessageCheckBox.jsx
    │   ├── MessageItem.jsx
    │   ├── Modal.jsx
    │   ├── QuestionInputBox.jsx
    │   ├── RoomHeader.jsx
    │   ├── SystemMessage.jsx
    │   └── Toast.jsx
    ├── hooks
    │   ├── useChatMessage.js
    │   ├── useChatRoomActions.js
    │   ├── useLocalStorage.js
    │   ├── useRoomUI.js
    │   ├── useToast.js
    │   └── useWebSocket.js
    ├── index.css
    ├── index.js
    ├── pages
    │   ├── HomePage.jsx
    │   └── RoomDetailPage.jsx
    ├── reportWebVitals.js
    ├── services
    │   ├── apis
    │   │   ├── chat.js
    │   │   ├── chatRoom.js
    │   │   └── instance.js
    │   └── socket
    │       └── socketClient.js
    └── setupTests.js

back

.
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── src
    └── main
        ├── java
        │   └── arkain
        │       └── dev
        │           └── communication
        │               ├── CommunicationApplication.java
        │               ├── chat
        │               │   ├── app
        │               │   │   ├── ChatMessageHandler.java
        │               │   │   ├── dto
        │               │   │   │   ├── ChatMessageDto.java
        │               │   │   │   ├── ChatRequestMessage.java
        │               │   │   │   ├── ChatResponseMessage.java
        │               │   │   │   ├── ChatRoomResponseDto.java
        │               │   │   │   ├── ChatRoomValidateDto.java
        │               │   │   │   └── RoomIdResponseDto.java
        │               │   │   └── service
        │               │   │       ├── ChatMessageHandlerService.java
        │               │   │       ├── ChatMessageService.java
        │               │   │       ├── ChatRoomService.java
        │               │   │       └── messageHandler
        │               │   │           ├── AbstractSystemMessageHandler.java
        │               │   │           ├── ChatHandler.java
        │               │   │           ├── JoinHandler.java
        │               │   │           ├── LeaveHandler.java
        │               │   │           └── SolveHandler.java
        │               │   ├── dao
        │               │   │   ├── ChatMessageRepository.java
        │               │   │   ├── ChatRoomRepository.java
        │               │   │   └── entity
        │               │   │       ├── ChatMessage.java
        │               │   │       ├── ChatRoom.java
        │               │   │       └── MessageType.java
        │               │   └── ui
        │               │       ├── message
        │               │       │   └── ChatController.java
        │               │       └── web
        │               │           ├── ChatMessageController.java
        │               │           ├── ChatMessageQueryController.java
        │               │           ├── ChatRoomCreateController.java
        │               │           └── ChatRoomValidateController.java
        │               ├── common
        │               │   ├── dao
        │               │   │   └── BaseTimeEntity.java
        │               │   └── handler
        │               │       └── GlobalExceptionHandler.java
        │               └── config
        │                   ├── AuditConfig.java
        │                   ├── CorsConfig.java
        │                   └── WebSocketConfig.java
        └── resources
            ├── application.properties
            ├── static
            └── templates

🔧 Tip & Guide

  1. Get URL and Port

    • You can get the default URL/Port and add URL/Port in the top right.
    • Hover on the [Preview]->[Running URL and Port] button in menu bar.

  2. Command feature

    • You can simply run your script using the shortcut icons on the top right.
    • Hover on the [Run]->[Add run command] button in menu bar.

  3. SSH Configuration

    • This feature is only available for membership users.
    • You can SSH to the Arkain container from the outside via the [Menu]->[SSH Configuration] in menu bar.

💬 Support & Documentation

Visit https://arkain.io to support and learn more about using arkain.

To watch usage guides, visit https://docs.arkain.io.