Skip to content

rakinmohammedrafeeq/zyren

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
backend
backend
 
 
frontend
frontend
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
SECURITY.md
SECURITY.md
 
 
docker-compose.yml
docker-compose.yml
 
 
package.json
package.json
 
 

Repository files navigation

Zyren Logo

Zyren – Secure Paste Sharing Platform

Zyren is a full-stack paste-sharing platform that allows users to create, manage, and share text/code snippets with optional expiration, public access via unique codes, and authentication with role-based access control (including an admin panel).
It is built using Spring Boot, React, PostgreSQL (Render), and Resend for email workflows, with optional Oracle DB for local development.

Key Features

Authentication & Roles

  • User registration and login with JWT authentication
  • Google OAuth2 sign-in (creates/links accounts and issues JWT on success)
  • Role-based access: USER and ADMIN
  • Admin-only access for user and paste management

Paste Management

  • Create, edit, delete personal pastes
  • Optional expiry (in minutes)
  • Auto-expiration scheduler and nightly cleanup
  • Public access using paste codes (auto-generates an 8-character code if left empty; supports letters, numbers, '-', and '_')
  • Fetch public pastes without authentication
  • Optional media metadata stored on pastes (URL + publicId + media type)

Media Uploads (Cloudinary)

  • Upload media via backend endpoint (multipart/form-data)
  • Supported types (server-side): JPEG, PNG, WebP, MP4/MOV, PDF
  • Size limits:
    • Backend: 20MB (spring.servlet.multipart.*)
    • UI guardrails: 15MB
  • Attach uploaded media to a paste (stored as mediaUrl, mediaPublicId, mediaType)
  • Secure deletion: only the paste owner (or an admin) can delete media, and the backend verifies the media belongs to the paste before deleting

Public Paste Access

  • Dedicated page to enter and view pastes by code
  • Shareable link generation

Admin Panel

  • List all users except the current admin
  • View a user’s pastes
  • Delete users with cascade cleanup (tokens + pastes)

Password Reset System

  • Forgot password: email reset link using Resend
  • Token validation with 30-minute expiry and single-use
  • Strong server-side password validation

UI/UX

  • React + Tailwind CSS v4
  • Dark/Light mode (saved in localStorage)
  • Responsive layout with modern design
  • Smooth transitions, toasts, and clean navigation

Integrations

  • Resend email API
  • Cloudinary media storage
  • Axios with JWT interceptors + consistent error toasts
  • Contact form and newsletter subscription endpoints

API Endpoints (Backend)

All backend routes are under the /api prefix unless noted.

Auth

  • POST /api/auth/register (form params: email, password)
  • POST /api/auth/login (form params: email, password) → returns { token, email, role }
  • POST /api/auth/forgot-password (JSON body: { "email": "..." })
  • POST /api/auth/reset-password?token=... (JSON body: { "newPassword": "..." })

OAuth2 (Google)

  • GET /oauth2/authorization/google (starts OAuth flow)
  • OAuth callback: handled by Spring Security (/login/oauth2/code/google)
  • Success handler redirects to the frontend route:
    • GET /oauth-success?token=... (frontend)

Note: the backend OAuth2 success handler currently redirects to http://localhost:5173/oauth-success?token=.... For production, this should be made environment-driven.

Paste

  • POST /api/paste (form params: title, content, optional expiryMinutes, optional code, optional mediaUrl, mediaPublicId, mediaType)
  • GET /api/paste/me (list your pastes)
  • PUT /api/paste/{id} (update title/content + optional media fields)
  • DELETE /api/paste/{id} (delete your paste)
  • DELETE /api/paste/admin/{id} (admin-only delete)

Public paste

  • GET /api/public/{code} (no auth)

Media

  • POST /api/media/upload (multipart file) → returns { secureUrl, publicId, resourceType }
  • DELETE /api/media/delete?pasteId=...&publicId=...

Admin

  • GET /api/admin/users
  • GET /api/admin/users/{id}/pastes
  • DELETE /api/admin/users/{id}

Contact + Newsletter

  • POST /api/contact (JSON body: contact form fields)
  • POST /api/newsletter/subscribe (JSON body: { "email": "..." })

Live Deployments

Technologies Used

Backend

  • Java 21
  • Spring Boot 3.5.x
  • Spring Security (JWT + OAuth2 Client)
  • Spring Data JPA
  • JWT (jjwt)
  • Resend API
  • Cloudinary
  • PostgreSQL (production) / Oracle (local development)
  • Maven
  • Docker support

Frontend

  • React 19 with Vite 6
  • TypeScript
  • Tailwind CSS v4
  • Radix UI
  • lucide-react icons
  • Axios + interceptors
  • React Router v7
  • Zod + React Hook Form
  • Sonner notifications

Project Structure

Zyren/
│
├── backend/                         # Spring Boot backend
│   ├── pom.xml
│   ├── Dockerfile                   # Multi-stage Maven build for Render
│   ├── docker-compose.yml           # Backend container config (optional local)
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/com/zyren/backend/
│   │   │   │   ├── ZyrenApplication.java
│   │   │   │   ├── config/          # Security, JWT, CORS, initializers
│   │   │   │   ├── auth/            # Login, register, reset-password, OAuth handlers
│   │   │   │   ├── user/            # User entity, admin controllers
│   │   │   │   ├── paste/           # Paste CRUD + public access API
│   │   │   │   ├── media/           # Cloudinary upload/delete endpoints
│   │   │   │   ├── contact/         # Contact & newsletter endpoints
│   │   │   │   ├── exception/       # Global exception handling
│   │   │   │   └── mail/            # Resend email service
│   │   └── resources/
│   │       └── application.yaml     # DB, JWT, Resend, Cloudinary config
│
├── frontend/                        # React + Vite frontend
│   ├── package.json
│   ├── vite.config.ts
│   ├── index.html
│   └── src/
│       ├── main.tsx
│       ├── contexts/                # AuthContext (JWT + role/provider state)
│       ├── api/                     # Axios client with interceptors
│       ├── lib/                     # Centralized API helper
│       ├── components/              # Reusable UI components
│       ├── pages/                   # Auth, Paste, Public, Admin pages
│       ├── ui/                      # Radix-style components
│       └── index.css                # Tailwind v4 config + themes
│
├── oradata/                          # Oracle Free DB data dir for local dev
│
├── docker-compose.yml                # Oracle database local setup
│
├── README.md                         # Project documentation
├── SECURITY.md                       # Security policy
├── LICENSE                           # MIT License
└── .gitignore                        # Git ignore rules

Setup & Installation

Backend Requirements

  • Java 21
  • Maven
  • PostgreSQL or Oracle

Required environment variables

Note: The backend reads most configuration from environment variables (and also supports loading from a local .env via java-dotenv).

SPRING_DATASOURCE_URL=
SPRING_DATASOURCE_USERNAME=
SPRING_DATASOURCE_PASSWORD=

JWT_SECRET=
JWT_EXPIRATION=

# Admin accounts (supports 2 configured admins)
ZYREN_ADMIN_EMAIL_1=
ZYREN_ADMIN_PASSWORD_1=
ZYREN_ADMIN_EMAIL_2=
ZYREN_ADMIN_PASSWORD_2=

# Email (Resend)
RESEND_API_KEY=
MAIL_TO=
RESET_BASE_URL=

# Cloudinary
CLOUDINARY_CLOUD_NAME=
CLOUDINARY_API_KEY=
CLOUDINARY_API_SECRET=

# Google OAuth
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

# CORS (comma-separated)
APP_CORS_ALLOWED_ORIGINS=http://localhost:5173,http://127.0.0.1:5173

PORT=

Local Development

Start the Backend

cd backend
./mvnw spring-boot:run

Frontend Environment Variables

The frontend requires a single environment variable:

VITE_API_BASE_URL=

If not provided, the frontend defaults to:

http://localhost:8080/api

Create a .env file inside the frontend/ folder:

frontend/.env

Add:

VITE_API_BASE_URL=http://localhost:8080/api

For production (Netlify), set the variable in Netlify → Site Settings → Environment Variables.

Start the Frontend

cd frontend
npm install
npm run dev

The frontend will run at:

http://localhost:5173

The backend will run at:

http://localhost:8080

Deployment

Live Production URLs

Your deployment setup includes:

  • Netlify → Hosts the React (Vite) frontend
  • Render → Hosts the Spring Boot backend (Dockerfile build)
  • Render → Provides PostgreSQL as the production database
  • Local Oracle DB via Docker → For local development option

Security Policy

For the complete security policy, refer to SECURITY.md.
It outlines:

  • Supported versions
  • Responsible disclosure guidelines
  • Private reporting process
  • Required information when reporting vulnerabilities
  • Response timelines

License

This project is licensed under the MIT License.

Contact

For any questions or suggestions, feel free to reach out:

Support

If you find this project useful, consider giving it a ⭐ on GitHub or supporting my work:

Buy Me a Coffee

About

Zyren is a secure paste-sharing platform with public code access, user accounts, role-based admin controls, and automatic expiration for text/code snippets.

zyren.netlify.app

Topics

react java docker postgres jwt spring-boot authentication backend oracle fullstack code-snippets tailwindcss resend-api paste-sharing

Resources

Readme

License

MIT license

Security policy

Security policy
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases 1

Zyren v1.0 Latest
Nov 16, 2025

Contributors

Languages