Getting Started
Greenlight is a modern, responsive portfolio built with React, Tailwind CSS, and shadcn/ui. All of your content lives in plain Markdown files — no CMS, no database, no fuss.
Prerequisites
- Node.js 20 or later
- Docker Desktop (optional — for containerised builds)
Quick start (local dev)
# 1. Clone the repo
git clone https://github.com/adrock-miles/greenlight.git
cd greenlight
# 2. Install dependencies
npm install
# 3. Start the dev server
npm run dev
Vite will open the site at http://localhost:5173. Edits to any file — including the Markdown in content/ — hot-reload instantly.
Project structure
greenlight/
├── content/ ← your portfolio content (Markdown)
│ ├── about.md
│ ├── contact.md
│ └── projects/
│ ├── project-1.md
│ └── project-2.md
├── src/
│ ├── components/ ← React components (shadcn/ui)
│ ├── pages/ ← route-level page components
│ ├── styles/ ← design tokens & global CSS
│ └── lib/ ← content loader utilities
├── docs/ ← this documentation site (Docusaurus)
├── Dockerfile ← production container image
└── package.json
Next steps
| Guide | What you'll learn |
|---|---|
| Content Overview | How the Markdown content system works |
| Edit About & Hero | Update your name, role, tagline, and bio |
| Add Projects | Create and manage project case studies |
| Edit Contact Info | Set up email, socials, and availability |
| Docker Setup | Run the site in Docker (macOS walkthrough) |
| GitHub Pages | Deploy these docs to GitHub Pages |