Skip to content

tagadearpit/Neosis

BranchesTags

Repository files navigation

Neosis animated header

Neosis animated introduction

🌐 Open Live Application  •  🚀 Quick Start  •  ☁️ Deployment  •  📚 Documentation

React 18.2 Vite 7.3 Spring Boot 3.2 Java 17 MongoDB 7 Docker ready MIT License

✨ Overview

Neosis is a full-stack private messaging platform built for real-time conversations, media sharing, persistent authentication, and browser-based audio/video communication.

The application combines a responsive React PWA with a Spring Boot API, MongoDB persistence, STOMP/SockJS messaging, Google OAuth 2.0 authentication, GridFS media storage, and WebRTC calls.

Neosis is structured as two independently deployable services:

  • Frontend: React, Vite, Tailwind CSS, Framer Motion and PWA support
  • Backend: Java 17, Spring Boot, Spring Security, WebSocket/STOMP and MongoDB

Important

Neosis protects traffic using HTTPS/WSS in production, but text messages and uploaded media are not end-to-end encrypted. The backend can access stored content. Do not describe this project as E2EE unless an independently reviewed client-side cryptographic protocol is added.

🧭 Table of Contents

🚀 Features

💬 Real-time messaging

  • One-to-one text conversations
  • STOMP messaging over SockJS/WebSocket
  • Persistent MongoDB message history
  • Typing indicators
  • Read receipts
  • Unread message counters
  • Optimistic message rendering
  • Server-backed conversation clearing

📎 Media and file sharing

  • Images
  • Videos
  • Audio files
  • Voice notes
  • Documents
  • Authenticated media retrieval
  • Configurable upload-size restrictions
  • MongoDB GridFS storage

📌 Conversation management

  • Pin and unpin chats
  • Mute and unmute conversations
  • Clear messages for the current user
  • Remove contacts
  • Contact information panel
  • Persistent per-user conversation preferences

👥 Contact workflow

  • Send contact requests
  • View pending requests
  • Accept or reject requests
  • View connected contacts
  • Remove existing contacts

📞 Audio and video calls

  • Browser-to-browser WebRTC calling
  • Audio and video call modes
  • STOMP-based signaling
  • Incoming-call acceptance or rejection
  • Busy-state handling
  • Camera and microphone permission handling
  • Configurable STUN/TURN infrastructure

🔐 Authentication and account controls

  • Google OAuth 2.0 login
  • Persistent MongoDB-backed sessions
  • Secure HttpOnly session cookies
  • User profile editing
  • Display-name and status updates
  • Notification-sound preference
  • Typing-indicator preference
  • Secure logout
  • Permanent account deletion
  • User-scoped cleanup of messages, media, contacts, preferences and sessions

📱 User experience

  • Responsive desktop and mobile interface
  • Installable Progressive Web App
  • Animated authentication/session loader
  • Accessible confirmation dialogs
  • Notification sounds
  • Reduced-motion support
  • SPA navigation with deployment-safe rewrites

🛡️ Production controls

  • Session-backed CSRF protection
  • Credentialed CORS allowlisting
  • HTTP rate limiting
  • WebSocket rate limiting
  • Bean validation and centralized error handling
  • File-size and MIME-type restrictions
  • Graceful shutdown
  • Spring Boot health probes
  • Non-root Docker runtime images
  • Automated dependency updates with Dependabot

🧰 Technology Stack

Layer Technologies
Frontend React 18, Vite 7, Tailwind CSS 4, Framer Motion, Lucide React
State and routing React Context, React Router
HTTP client Axios
Real-time transport STOMP, SockJS, WebSocket
Calls WebRTC, STUN and optional TURN
PWA Vite PWA plugin, service worker, web manifest
Backend Java 17, Spring Boot 3.2
Security Spring Security, OAuth 2.0, CSRF, secure sessions
Data MongoDB, Spring Data MongoDB, GridFS
Session store Spring Session Data MongoDB
Operations Actuator, Docker, Docker Compose, GitHub Actions
Hosting Render Static Site + Render Web Service

🏗️ System Architecture

flowchart LR
    U[User Browser / PWA]
    F[React + Vite Frontend]
    A[Spring Boot API]
    W[STOMP / SockJS Gateway]
    O[Google OAuth 2.0]
    M[(MongoDB)]
    G[(GridFS Media)]
    R[STUN / TURN]
    P[Peer Browser]

    U --> F
    F -->|HTTPS REST + Session Cookie| A
    F <-->|WSS Real-time Events| W
    W --> A
    A <-->|OAuth flow| O
    A --> M
    A --> G
    F <-->|WebRTC Media| P
    F -. ICE negotiation .-> R
    P -. ICE negotiation .-> R
Loading

Request flow

  1. The browser starts Google OAuth through the Spring Boot backend.
  2. The backend creates a server-side session stored in MongoDB.
  3. The browser receives only a secure HttpOnly session cookie.
  4. REST APIs handle users, contacts, conversation preferences, history and uploads.
  5. STOMP/WebSocket handles messages, typing events and WebRTC signaling.
  6. WebRTC sends call media directly between peers where possible.
  7. TURN relays call media when direct peer connectivity is unavailable.

📁 Project Structure

Neosis/
├── .github/
│   ├── dependabot.yml
│   └── workflows/
├── neosis-frontend/
│   ├── public/
│   ├── src/
│   │   ├── components/
│   │   │   ├── ConfirmDialog.jsx
│   │   │   ├── ContactInfoModal.jsx
│   │   │   ├── Login.jsx
│   │   │   ├── NeosisChat.jsx
│   │   │   └── SettingsModal.jsx
│   │   ├── context/
│   │   │   └── AuthContext.jsx
│   │   ├── App.jsx
│   │   ├── api.js
│   │   ├── index.css
│   │   └── main.jsx
│   ├── Dockerfile
│   ├── nginx.conf
│   ├── package.json
│   └── vite.config.js
├── neosis-backend/
│   ├── src/main/java/com/neosis/
│   │   ├── config/
│   │   ├── controller/
│   │   ├── dto/
│   │   ├── model/
│   │   └── repository/
│   ├── src/main/resources/application.yml
│   ├── Dockerfile
│   └── pom.xml
├── neosis-github-wiki/
├── docker-compose.yml
├── PRODUCTION_AUDIT.md
├── VALIDATION_REPORT.md
├── LICENSE
└── README.md

⚡ Quick Start

Prerequisites

Install the following tools:

  • Java 17 or newer
  • Maven 3.9 or newer
  • Node.js 20.19–22.x
  • npm
  • MongoDB 7.x, or a MongoDB Atlas database
  • A Google OAuth 2.0 Web Application client

1. Clone the repository

git clone https://github.com/tagadearpit/Neosis.git
cd Neosis

2. Configure the backend

cd neosis-backend
cp .env.example .env

Edit neosis-backend/.env:

PORT=8080
MONGO_URI=mongodb://localhost:27017/neosis
FRONTEND_URL=http://localhost:5173
GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret
SESSION_COOKIE_SECURE=false
SESSION_COOKIE_SAME_SITE=lax

Load the variables and start Spring Boot.

Linux or macOS

set -a
source .env
set +a
mvn spring-boot:run

Windows PowerShell

$env:PORT="8080"
$env:MONGO_URI="mongodb://localhost:27017/neosis"
$env:FRONTEND_URL="http://localhost:5173"
$env:GOOGLE_CLIENT_ID="your-google-client-id"
$env:GOOGLE_CLIENT_SECRET="your-google-client-secret"
$env:SESSION_COOKIE_SECURE="false"
$env:SESSION_COOKIE_SAME_SITE="lax"
mvn spring-boot:run

The backend runs at:

http://localhost:8080

3. Configure the frontend

Open another terminal:

cd neosis-frontend
cp .env.example .env
npm ci
npm run dev

Frontend environment:

VITE_BACKEND_URL=http://localhost:8080

Open:

http://localhost:5173

🔧 Environment Variables

Backend variables

Variable Required Example Description
PORT No 8080 HTTP port. Render supplies this automatically.
MONGO_URI Yes mongodb://localhost:27017/neosis MongoDB connection URI.
FRONTEND_URL Yes https://neosis-static-site.onrender.com Exact allowed frontend origin, without a trailing slash.
GOOGLE_CLIENT_ID Yes ...apps.googleusercontent.com Google OAuth Web Application client ID.
GOOGLE_CLIENT_SECRET Yes secret Google OAuth client secret. Never expose this to the frontend.
SESSION_COOKIE_SECURE Yes in production true Sends the session cookie only over HTTPS.
SESSION_COOKIE_SAME_SITE Yes none Use none when frontend and backend use separate domains.

Frontend build variables

Variable Required Example Description
VITE_BACKEND_URL Yes https://neosis-api.onrender.com Public backend URL, without a trailing slash.
VITE_TURN_URL Recommended turn:turn.example.com:3478 TURN server address for reliable calls.
VITE_TURN_USERNAME With TURN username TURN username.
VITE_TURN_CREDENTIAL With TURN credential TURN credential. Visible in the browser bundle.

Caution

Every variable beginning with VITE_ is compiled into the public frontend bundle. Never place database passwords, OAuth client secrets, private API keys or administrative credentials in a VITE_ variable.

🔑 Google OAuth Setup

Create an OAuth 2.0 Web Application in Google Cloud Console.

Local development

Authorized JavaScript origin:

http://localhost:5173

Authorized redirect URI:

http://localhost:8080/login/oauth2/code/google

Production

Authorized JavaScript origin:

https://YOUR-FRONTEND-HOST

Authorized redirect URI:

https://YOUR-BACKEND-HOST/login/oauth2/code/google

The redirect URI must match exactly. A different hostname, path, protocol or trailing slash can cause redirect_uri_mismatch.

🐳 Docker Setup

Create a root .env file:

GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret

Build and start the complete stack:

docker compose up --build

Services:

Service Address
Frontend http://localhost:5173
Backend http://localhost:8080
MongoDB Internal Docker network

Stop the stack:

docker compose down

Remove the local MongoDB volume as well:

docker compose down -v

Warning

The -v option permanently removes the Docker Compose database volume.

☁️ Deployment

Neosis is designed to run as two Render services from the same repository.

Frontend — Render Static Site

Setting Value
Service type Static Site
Root directory neosis-frontend
Build command npm ci && npm run build
Publish directory dist
Environment variable VITE_BACKEND_URL=https://YOUR-BACKEND.onrender.com

Add this SPA rewrite:

Source Destination Action
/* /index.html Rewrite

Backend — Render Web Service

Setting Value
Service type Web Service
Runtime Docker
Root directory neosis-backend
Dockerfile path ./Dockerfile
Health check path /actuator/health
Build command Leave empty
Start command Leave empty

Required production variables:

MONGO_URI=mongodb+srv://USER:PASSWORD@CLUSTER.mongodb.net/neosis?retryWrites=true&w=majority
FRONTEND_URL=https://YOUR-FRONTEND.onrender.com
GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret
SESSION_COOKIE_SECURE=true
SESSION_COOKIE_SAME_SITE=none

Recommended deployment order

  1. Deploy the backend.
  2. Copy the backend URL.
  3. Add it as VITE_BACKEND_URL on the frontend.
  4. Deploy the frontend.
  5. Copy the frontend URL.
  6. Add it as FRONTEND_URL on the backend.
  7. Configure the production Google OAuth origin and callback URI.
  8. Redeploy both services.

🔌 API Overview

All user-scoped endpoints require an authenticated session unless noted otherwise.

Authentication and security

Method Endpoint Purpose
GET /oauth2/authorization/google Start Google OAuth login
GET /login/oauth2/code/google Google OAuth callback
GET /api/csrf Obtain the CSRF token
POST /logout End the authenticated session

Users and settings

Method Endpoint Purpose
GET /api/users/me Read the current profile
PATCH /api/users/me Update display name or status
PATCH /api/users/me/preferences Update application preferences
DELETE /api/users/me Permanently delete the account
POST /api/users/accept-terms Record terms acceptance
GET /api/users/check Check authentication status

Contacts

Method Endpoint Purpose
POST /api/contacts/request Send a contact request
GET /api/contacts/pending List pending requests
POST /api/contacts/accept Accept a request
POST /api/contacts/reject Reject a request
GET /api/contacts/friends List connected contacts

Conversations and messages

Method Endpoint Purpose
GET /api/conversations List conversation summaries
PATCH /api/conversations/{contactEmail} Update pin or mute preference
DELETE /api/conversations/{contactEmail}/messages Clear the conversation for the current user
DELETE /api/conversations/{contactEmail} Remove a contact/conversation
GET /api/messages/history/{friendEmail} Load message history
POST /api/messages/read/{friendEmail} Mark messages as read
POST /api/chat/upload Upload authenticated media
GET /api/chat/media/{id} Retrieve authorized media

WebSocket destinations

Destination Purpose
/app/chat.send Send a real-time chat message
/app/chat.typing Publish a typing state
/app/chat.signal Exchange WebRTC signaling events

See neosis-github-wiki/API-Reference.md for additional details.

🛡️ Security Model

Neosis includes several baseline production controls:

  • OAuth authentication instead of application-managed passwords
  • Server-side sessions persisted in MongoDB
  • HttpOnly session cookies
  • Secure and SameSite cookie configuration
  • Session-backed CSRF tokens
  • Explicit credentialed CORS origin
  • Request validation
  • Centralized API error responses
  • HTTP and WebSocket rate limiting
  • Authenticated media endpoints
  • Media ownership checks
  • File-size and MIME-type restrictions
  • Non-root Docker containers
  • Health endpoints with restricted details
  • Secure Nginx headers for containerized frontend delivery

Current security boundary

Area Current behavior
Network transport HTTPS/WSS in production
Session credential HttpOnly secure cookie
Stored text messages Plaintext application data in MongoDB
Stored media Application-accessible GridFS objects
WebRTC media DTLS-SRTP transport
End-to-end encryption Not implemented
Malware scanning Not implemented

For public deployment at scale, add content-signature validation, malware scanning, abuse controls, security-event auditing, retention policies, secret rotation and an external penetration test.

Detailed findings are documented in PRODUCTION_AUDIT.md.

✅ Validation and Testing

Frontend

cd neosis-frontend
npm ci
npm run build

Backend

cd neosis-backend
mvn clean verify

Docker

docker compose build --no-cache
docker compose up

Manual smoke-test checklist

  • Google login succeeds
  • Session remains valid after a browser refresh
  • Logout invalidates the session
  • Profile settings persist
  • Contact requests can be accepted and rejected
  • Text messages arrive in real time
  • Message history reloads correctly
  • Read receipts and unread counters update
  • Pin and mute settings persist
  • Chat clearing remains cleared after reload
  • Media upload and download permissions are enforced
  • Audio and video calls work across separate networks
  • Account deletion removes user-owned data
  • /actuator/health reports a healthy backend

See VALIDATION_REPORT.md for the validation record included with the project.

📊 Operational Notes

Health endpoint

GET /actuator/health

Use this endpoint for Render health checks and container probes.

Database

  • Use MongoDB Atlas or a managed replica set in production.
  • Restrict the database user to the Neosis database.
  • Enable backups and test restoration regularly.
  • Keep MONGO_URI only in backend secret storage.

Calls

Public STUN servers alone are not sufficient for reliable WebRTC connectivity. Configure TURN for users behind mobile carrier NAT, enterprise firewalls or restrictive Wi-Fi networks.

Scaling limitation

The current embedded STOMP broker and in-memory rate-limit buckets are suitable for a single backend instance.

Before horizontal scaling, replace them with shared infrastructure such as:

  • RabbitMQ STOMP relay or another external broker
  • Redis-backed/distributed rate limiting
  • Shared presence and call-state management
  • Centralized logs, metrics and traces

Free hosting behavior

A sleeping or cold-starting backend can delay login, WebSocket connection, presence and incoming-call behavior. Use an always-on backend instance for time-sensitive real-time communication.

🧯 Troubleshooting

Login remains on “Verifying secure session”

Check:

  1. VITE_BACKEND_URL points to the correct HTTPS backend.
  2. FRONTEND_URL exactly matches the deployed frontend origin.
  3. SESSION_COOKIE_SECURE=true in production.
  4. SESSION_COOKIE_SAME_SITE=none for separate Render domains.
  5. Google OAuth redirect URI points to the backend callback.
  6. MongoDB is reachable and the backend health endpoint is healthy.
  7. The browser is not blocking third-party/cross-site cookies.

After changing a Vite variable, rebuild the frontend because VITE_ values are compile-time variables.

Google reports redirect_uri_mismatch

Add the exact callback URI in Google Cloud Console:

https://YOUR-BACKEND-HOST/login/oauth2/code/google

The callback belongs to the backend, not the frontend.

Directly opening /login or another route returns 404

Add the Render Static Site rewrite:

/*  →  /index.html

Set the action to Rewrite, not Redirect.

Messages do not update in real time

Check the browser Network tab for the SockJS/WebSocket connection and confirm:

  • Backend service is awake and healthy
  • CORS origin matches the frontend
  • Session cookie is present
  • Proxy allows WebSocket upgrades
  • No stale PWA bundle is using an old backend URL
Audio or video calls work only on some networks

Configure VITE_TURN_URL, VITE_TURN_USERNAME and VITE_TURN_CREDENTIAL. Direct peer connectivity can fail behind CGNAT and enterprise firewalls.

The deployed frontend still shows an old version

The PWA service worker may have cached older assets. Use a hard refresh, clear site data, or trigger a Render Clear build cache & deploy operation.

🗺️ Roadmap

Potential production improvements:

  • Audited end-to-end encryption protocol
  • Multi-device key and session management
  • Group conversations
  • Message reactions and replies
  • Edit and delete individual messages
  • Full-text conversation search
  • Push notifications
  • Temporary TURN credentials
  • Malware scanning for uploads
  • Object storage/CDN media pipeline
  • External STOMP broker
  • Redis-backed distributed rate limiting
  • OpenTelemetry traces and centralized metrics
  • Administrative abuse-management controls
  • Automated end-to-end browser tests

🤝 Contributing

  1. Fork the repository.
  2. Create a focused branch:
git checkout -b feature/your-change
  1. Keep frontend and backend changes backward-compatible where possible.
  2. Add validation and error handling for new API inputs.
  3. Run the production checks:
cd neosis-frontend && npm ci && npm run build
cd ../neosis-backend && mvn clean verify
  1. Commit using a clear message:
git commit -m "Add concise description of change"
  1. Push the branch and open a pull request.

Pull requests should explain behavior changes, security impact, migration requirements, test coverage and operational risks.

📚 Additional Documentation

📄 License

This project is distributed under the MIT License. See LICENSE for the complete license text.

👨‍💻 Maintainer

Arpit Tagade
Full-Stack AI Engineer and hardware developer

Arpit Tagade on GitHub Open Neosis

Built for maintainable real-time communication—not just a UI demo.

⬆ Back to top

Neosis footer

About

Real-time secure messaging platform built with Spring Boot, React, MongoDB, WebSockets, and WebRTC. Neosis supports persistent chat, contact management, media sharing, audio/video calls, OAuth login, CSRF protection, and production-focused security controls.

neosis-static-site.onrender.com

Topics

spring-boot websocket webrtc chat-application real-time-chat mongodb-atlas secure-messaging

Resources

Readme

License

MIT license
Activity

Stars

1 star

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

 
 
 

Contributors 1

Languages