Snipper - Code Snippet Sharing Platform

A production-ready code snippet sharing platform built with Spring Boot, React, Docker, and Kubernetes. Share, discover, and manage code snippets with Markdown support and syntax highlighting.

Features

Secure Authentication - JWT-based authentication with refresh tokens
Markdown Support - Rich text editing with live Markdown preview
Syntax Highlighting - Support for 20+ programming languages via Prism.js
Search & Filter - Full-text search with language and tag filtering
User Dashboard - Manage snippets with statistics and activity tracking
Public/Private Snippets - Control snippet visibility
Responsive Design - Mobile-friendly interface
Containerized - Docker and Docker Compose ready
Kubernetes Ready - Production-grade K8s manifests
CI/CD Pipeline - Automated testing and deployment with GitHub Actions

Tech Stack

Backend

Framework: Spring Boot 3.2.0
Language: Java 17
Database: MySQL 8.0
Security: Spring Security + JWT
ORM: Spring Data JPA + Hibernate
Migration: Flyway
Testing: JUnit 5, Mockito
Build: Maven

Frontend

Framework: React 18
Routing: React Router v6
HTTP Client: Axios
Styling: CSS Modules
Markdown: React-Markdown
Syntax Highlighting: Prism.js
Build: Create React App

Infrastructure

Containerization: Docker, Docker Compose
Orchestration: Kubernetes
CI/CD: GitHub Actions
Monitoring: Spring Boot Actuator, Prometheus
Web Server: Nginx (frontend)

Quick Start

Prerequisites

Java 17+
Node.js 18+
MySQL 8.0+
Docker & Docker Compose (optional)
kubectl & Minikube/K8s cluster (optional)

Local Development

1. Clone the Repository

git clone https://github.com/username/snipper.git
cd snipper

2. Start MySQL

docker run -d \
  --name snipper-mysql \
  -e MYSQL_ROOT_PASSWORD=rootpassword \
  -e MYSQL_DATABASE=snipper \
  -e MYSQL_USER=snipper_user \
  -e MYSQL_PASSWORD=snipper_password \
  -p 3306:3306 \
  mysql:8.0

3. Run Backend

cd backend
mvn spring-boot:run

Backend will start on http://localhost:9090

4. Run Frontend

cd frontend
npm install
npm start

Frontend will start on http://localhost:3000

Using Docker Compose

# Build and start all services
docker-compose up --build

# Access the application
# Frontend: http://localhost:3000
# Backend: http://localhost:9090
# MySQL: localhost:3306

See DOCKER_SETUP.md for detailed Docker instructions.

Using Kubernetes

# Apply all manifests
kubectl apply -f k8s/

# Check deployment status
kubectl get pods -n snipper

# Access the application
kubectl get svc frontend-service -n snipper

See KUBERNETES_SETUP.md for detailed Kubernetes instructions.

Project Structure

snipper/
├── backend/                    # Spring Boot backend
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/com/snipper/
│   │   │   │   ├── config/           # Configuration classes
│   │   │   │   ├── controller/       # REST controllers
│   │   │   │   ├── dto/              # Data Transfer Objects
│   │   │   │   ├── exception/        # Exception handling
│   │   │   │   ├── health/           # Health indicators
│   │   │   │   ├── model/            # JPA entities
│   │   │   │   ├── repository/       # Data repositories
│   │   │   │   ├── security/         # Security configuration
│   │   │   │   └── service/          # Business logic
│   │   │   └── resources/
│   │   │       ├── db/migration/     # Flyway migrations
│   │   │       └── application*.yml  # Configuration files
│   │   └── test/                     # Unit & integration tests
│   ├── Dockerfile
│   └── pom.xml
│
├── frontend/                   # React frontend
│   ├── public/
│   ├── src/
│   │   ├── components/              # React components
│   │   │   ├── auth/                # Authentication components
│   │   │   ├── common/              # Shared components
│   │   │   ├── layout/              # Layout components
│   │   │   └── snippet/             # Snippet components
│   │   ├── contexts/                # React contexts
│   │   ├── pages/                   # Page components
│   │   ├── services/                # API services
│   │   └── App.js
│   ├── Dockerfile
│   ├── nginx.conf
│   └── package.json
│
├── k8s/                        # Kubernetes manifests
│   ├── namespace.yaml
│   ├── configmap.yaml
│   ├── secret.yaml
│   ├── mysql-*.yaml
│   ├── backend-deployment.yaml
│   ├── frontend-deployment.yaml
│   └── hpa.yaml
│
├── .github/workflows/          # CI/CD pipelines
│   ├── backend-ci.yml
│   ├── frontend-ci.yml
│   ├── docker-build.yml
│   └── deploy.yml
│
├── docker-compose.yml
└── README.md

API Documentation

Authentication Endpoints

POST   /api/auth/register    - Register new user
POST   /api/auth/login       - Login user
POST   /api/auth/refresh     - Refresh JWT token

Snippet Endpoints

GET    /api/snippets         - Get all snippets (paginated)
GET    /api/snippets/{id}    - Get snippet by ID
POST   /api/snippets         - Create new snippet
PUT    /api/snippets/{id}    - Update snippet
DELETE /api/snippets/{id}    - Delete snippet
GET    /api/snippets/search  - Search snippets

User Endpoints

GET    /api/users/profile              - Get current user profile
PUT    /api/users/profile              - Update user profile
GET    /api/users/{username}/snippets  - Get user's snippets

Health Check Endpoints

GET    /actuator/health           - Application health status
GET    /actuator/health/liveness  - Liveness probe
GET    /actuator/health/readiness - Readiness probe
GET    /actuator/metrics          - Application metrics
GET    /actuator/prometheus       - Prometheus metrics

Configuration

Backend Configuration

Edit backend/src/main/resources/application-dev.yml:

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/snipper
    username: snipper_user
    password: snipper_password
  
  security:
    jwt:
      secret: your-secret-key-min-256-bits
      expiration: 86400000  # 24 hours

Frontend Configuration

Edit frontend/package.json:

{
  "proxy": "http://localhost:9090"
}

Or set environment variable:

REACT_APP_API_URL=http://localhost:9090

Testing

Backend Tests

cd backend

# Run all tests
mvn test

# Run specific test class
mvn test -Dtest=UserServiceTest

# Run with coverage
mvn test jacoco:report

Frontend Tests

cd frontend

# Run all tests
npm test

# Run with coverage
npm test -- --coverage

# Run specific test
npm test -- SnippetEditor.test.js

Deployment

Docker Deployment

See DOCKER_SETUP.md for complete Docker deployment guide.

Kubernetes Deployment

See KUBERNETES_SETUP.md for complete Kubernetes deployment guide.

CI/CD Pipeline

See CI_CD_GUIDE.md for CI/CD pipeline documentation.

Monitoring

Health Checks

# Backend health
curl http://localhost:9090/actuator/health

# Frontend health
curl http://localhost:3000/

Metrics

# Application metrics
curl http://localhost:9090/actuator/metrics

# Prometheus metrics
curl http://localhost:9090/actuator/prometheus

See MONITORING_GUIDE.md for complete monitoring setup.

Development

Backend Development

cd backend

# Run in development mode
mvn spring-boot:run

# Run with specific profile
mvn spring-boot:run -Dspring-boot.run.profiles=dev

# Build JAR
mvn clean package

# Skip tests
mvn clean package -DskipTests

Frontend Development

cd frontend

# Install dependencies
npm install

# Start development server
npm start

# Build for production
npm run build

# Run linter
npm run lint

# Fix linting issues
npm run lint:fix

Database Migrations

Flyway migrations are in backend/src/main/resources/db/migration/

# Migrations run automatically on startup

# To create a new migration:
# 1. Create file: V{version}__Description.sql
# 2. Example: V4__Add_user_avatar.sql

Troubleshooting

Backend Issues

Port already in use:

# Find process using port 9090
lsof -i :9090  # macOS/Linux
netstat -ano | findstr :9090  # Windows

# Kill the process
kill -9 <PID>  # macOS/Linux
taskkill /PID <PID> /F  # Windows

Database connection failed:

# Check MySQL is running
docker ps | grep mysql

# Check connection
mysql -h localhost -u snipper_user -p

Frontend Issues

Module not found:

# Clear cache and reinstall
rm -rf node_modules package-lock.json
npm install

Build fails:

# Clear build cache
rm -rf build
npm run build

Docker Issues

Container won't start:

# Check logs
docker logs snipper-backend
docker logs snipper-frontend
docker logs snipper-mysql

# Restart containers
docker-compose restart

Contributing

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Code Style

Backend: Follow Java code conventions, use Spring Boot best practices
Frontend: Follow Airbnb React/JavaScript style guide
Commits: Use conventional commits format

Pull Request Process

Update documentation for any new features
Add tests for new functionality
Ensure all tests pass
Update the README if needed
Request review from maintainers

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Spring Boot team for the excellent framework
React team for the amazing library
Prism.js for syntax highlighting
React-Markdown for Markdown rendering
All contributors and users of this project

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
.github/workflows		.github/workflows
.kiro/specs/snipper		.kiro/specs/snipper
.vscode		.vscode
PICS		PICS
backend		backend
frontend		frontend
k8s		k8s
API_DOCUMENTATION.md		API_DOCUMENTATION.md
CI_CD_GUIDE.md		CI_CD_GUIDE.md
DEPLOYMENT_STATUS.md		DEPLOYMENT_STATUS.md
DOCKER_SETUP.md		DOCKER_SETUP.md
KUBERNETES_SETUP.md		KUBERNETES_SETUP.md
LOCAL_DEPLOYMENT_SUCCESS.md		LOCAL_DEPLOYMENT_SUCCESS.md
MONITORING_GUIDE.md		MONITORING_GUIDE.md
PROJECT_REVIEW.md		PROJECT_REVIEW.md
README.md		README.md
docker-compose.yml		docker-compose.yml
insert_sample_data.sql		insert_sample_data.sql

Folders and files

Latest commit

History

Repository files navigation

Snipper - Code Snippet Sharing Platform

Features

Tech Stack

Backend

Frontend

Infrastructure

Quick Start

Prerequisites

Local Development

1. Clone the Repository

2. Start MySQL

3. Run Backend

4. Run Frontend

Using Docker Compose

Using Kubernetes

Project Structure

API Documentation

Authentication Endpoints

Snippet Endpoints

User Endpoints

Health Check Endpoints

Configuration

Backend Configuration

Frontend Configuration

Testing

Backend Tests

Frontend Tests

Deployment

Docker Deployment

Kubernetes Deployment

CI/CD Pipeline

Monitoring

Health Checks

Metrics

Development

Backend Development

Frontend Development

Database Migrations

Troubleshooting

Backend Issues

Frontend Issues

Docker Issues

Contributing

Code Style

Pull Request Process

License

Acknowledgments

Support

Roadmap

Authors

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages