History

Yangshun Tay 841cf3c36b [website][misc] change announcement banner		2 years ago
..
blog	website: move into monorepo	2 years ago
contents	[website][contents] mention resume review portal	2 years ago
experimental	website: move into monorepo	2 years ago
src	[website][contents] mention resume review portal	2 years ago
static	website: move into monorepo	2 years ago
.gitignore	website: move into monorepo	2 years ago
README.md	website: move into monorepo	2 years ago
docusaurus.config.js	[website][misc] change announcement banner	2 years ago
package.json	website: move into monorepo	2 years ago
sidebars.js	website: move into monorepo	2 years ago
vercel.json	website: move into monorepo	2 years ago

README.md

Website

This website is built using Docusaurus 2, a modern static website generator. It is part of a Turborepo monorepo setup.

Installation

We use Yarn 1 as the package manager. At the root of the repository, run yarn to install the monorepo dependencies.

$ yarn

Local Development

Also at the root of the repository, run:

$ yarn dev:website

This command starts a local development server and opens up a browser window. Most changes made to JavaScript and Markdown files will be reflected instantly without having to restart the server.

Build

Navigate to the apps/website directory.

cd apps/website
$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=1 yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.