Skip to content

RK Website CoreModern TypeScript/Next.js Development

Complete full-stack development documentation with DevOps automation

RK Website Core

Quick Start โ€‹

Get up and running in minutes with the container-first development environment:

bash
# Clone the repository
git clone https://github.com/rumankazi/rk-website-core.git
cd rk-website-core

# Open in VS Code Dev Container
code .
# Click "Reopen in Container" when prompted

# Install dependencies
pnpm install

# Start development server
pnpm dev

Architecture Overview โ€‹

This project follows a container-first development strategy with:

  • Next.js 14+ with App Router for modern React development
  • TypeScript in strict mode for type safety
  • Prisma ORM for type-safe database operations
  • Tailwind CSS for utility-first styling
  • Cloud Run deployment on Google Cloud Platform
  • Terraform for Infrastructure as Code
  • GitHub Actions for comprehensive CI/CD

Project Structure โ€‹

โ”œโ”€โ”€ src/app/              # Next.js App Router
โ”œโ”€โ”€ src/components/       # Reusable UI components
โ”œโ”€โ”€ src/lib/             # Database, auth, and utilities
โ”œโ”€โ”€ prisma/              # Database schema and migrations
โ”œโ”€โ”€ tests/               # Unit, integration, and E2E tests
โ”œโ”€โ”€ docs/                # VitePress documentation
โ”œโ”€โ”€ infrastructure/      # Terraform IaC configurations
โ”œโ”€โ”€ .devcontainer/       # VS Code Dev Container setup
โ””โ”€โ”€ .github/workflows/   # CI/CD automation

Key Features โ€‹

  • ๐Ÿ”ง Complete Development Environment: VS Code Dev Containers with all tools pre-configured
  • ๐Ÿ“ฆ Monorepo Structure: Organized codebase with clear separation of concerns
  • ๐Ÿงช Comprehensive Testing: Unit tests (Vitest), E2E tests (Playwright), and integration testing
  • ๐Ÿ“ˆ Quality Automation: ESLint, Prettier, TypeScript, and security scanning in CI/CD
  • ๐ŸŒ Multi-Environment Deployment: Separate staging and production environments
  • ๐Ÿ“– Living Documentation: Auto-updated documentation with every code change

Development Philosophy

This project emphasizes learning through building - documenting every decision, implementing best practices, and automating everything possible for a production-ready development experience.

Built with โค๏ธ using TypeScript, Next.js, and VitePress