Skip to content

LowWeiLin/light

Repository files navigation

light

This project was bootstrapped with Create Next Stack!

To get started, run:

yarn dev

Scripts

The table below provides names and descriptions of the scripts available in this project.

Each script is run using yarn <script-name>. For example: yarn dev.

Name Description
dev Runs the Next.js development server.
build Generates a production build.
deploy Deploys to Github Pages.
start Runs the Next.js production server built using build script.
lint Runs ESLint to catch linting errors in the source code.
format Formats all source code in the project.
format:check Checks the formatting of all code in the project.
prepare The prepare life cycle script is used to set up Git pre-commit hooks when people run yarn install. This script should not be run manually.

Technologies

The table below gives an overview of the technologies used in this project, as well as places to learn more about them.

Name Links
Next.js Docs - Learn Next.js - GitHub repo
React Docs - GitHub repo
TypeScript Docs - GitHub repo
CSS Modules Docs - Next.js-specific docs
Sass Docs - Next.js-specific docs
ESLint Configuration - Rules - GitHub Repo
Prettier Docs - Options - GitHub repo
Husky Docs - GitHub repo
lint-staged GitHub repo
Yarn CLI Docs - GitHub repo
GitHub Actions Docs - Workflow syntax
GitHub Pages Deployment