Skip to content

paulsilcock/homepage

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.

The theme is inspired by this Vercel NextJS template.

Quick Start

Ensure node and npm are installed first:

npm install
npm run dev # runs dev server on localhost:3000

Overview

This project is built and deployed to my gke cluster.

Deployments

This repo uses commitlint to enforce conventional commits - husky will automatically install git hooks upon npm install. To trigger a new release, the commit must be one of fix: or feat:. @semantic-release will increment the version and tag the repo as appropriate.

On successful release, staging is automatically updated - the ArgoCD controller will deploy the new version.

To update production, update the newTag field manually.

Structure

  • pages/* - static pages (e.g. index.tsx corresponds pauljs.io/)
  • components/* - reusable components
  • public/* - static assets such as images and fonts
  • stories/* - storybook component stories
  • Dockerfile - image built and deployed here

Storybook

Storybook is included, and will be used to build/test components in isolation. Run npm run storybook to view the storybook dev server @ localhost:6006.