Skip to main content

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

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

GuideWhat you'll learn
Content OverviewHow the Markdown content system works
Edit About & HeroUpdate your name, role, tagline, and bio
Add ProjectsCreate and manage project case studies
Edit Contact InfoSet up email, socials, and availability
Docker SetupRun the site in Docker (macOS walkthrough)
GitHub PagesDeploy these docs to GitHub Pages