README.md

Project Overview

This project is a application that powers user interface of my website.

Stack overview

• Server side rendered React app which uses NextJS
• Written in TypeScript
• Written in TypeScript
• Uses styled-component for styling
• material-ui is used in combination with regular components
• Husky is used to ensure eslint and commitlint is run before each commit
• Uses conventional commit for commit lint rule
• Uses jest and enzyme for test

Run Project Locally

1. git clone {this repo}
2. npm install or yarn
3. npm run dev (or npm run start if you want to create production optimized build
4. visit localhost:3000

Environment Variables

Key	Value	Note
NEXT_PUBLIC_EXE_CTX	String indicates execution enviornment	Required
NEXT_PUBLIC_MINIKUBE_IP	IP address of minikube cluster	Required when running app in minikube