VROOM

Vite React Optimized Opinionated Material

A production-ready React + TypeScript template with Vite, Material UI, Docker, and NGINX.

Why VROOM?

Skip the setup. Everything from TypeScript configs to Docker deployment is ready to go. Clone, install, and start building.

---

Features

• React + TypeScript + Vite
• Material UI components
• React Router
• Docker + NGINX
• ESLint + Prettier
• Environment variables support

---

Requirements

Node.js 18+, npm/yarn, Docker

---

Quick Start

Linux/macOS:

bash <(curl -fsSL https://raw.githubusercontent.com/IgnitedIce/vroom/main/scripts/setup.sh) my-project-name

Windows:

irm https://raw.githubusercontent.com/IgnitedIce/vroom/main/scripts/setup.ps1 | iex

Or clone manually:

git clone https://github.com/IgnitedIce/vroom.git my-project-name && (cd my-project-name && ./scripts/setup.sh my-project-name)

---

Development

yarn         # Install dependencies
yarn dev     # Start dev server
yarn build   # Production build → dist/

Docker

yarn docker:build              # Build image (use sudo on Linux/macOS)
docker run -d -p 8080:80 vroom # Run container (use sudo on Linux/macOS)
# Visit http://localhost:8080

---

Environment Variables

Prefix variables with VITE_ in your .env file:

VITE_APP_NAME=VROOM
VITE_API_URL=http://localhost:3000/api

Access in code:

const appName = import.meta.env.VITE_APP_NAME;

---

Structure

src/
  components/    # Shared React components
  ctx/           # React contexts
  hooks/         # Custom hooks
  lib/           # Utility functions
  pages/         # Route pages
  types.d.ts     # Global TypeScript types
docker/          # Docker configs
public/          # Static assets

---

License

Public domain (The Unlicense) • Created by IgnitedIce