Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 1.77 KB

0. Quick Start.md

File metadata and controls

65 lines (41 loc) · 1.77 KB

Getting Started > Quick Start

Prerequisites

Node 16+ (node -v)
pnpm 8.x+ (pnpm -v)

pnpm workspaces

This repo uses pnpm workspaces. When installing dependencies, running pnpm install from any directory listed as a package in the workspace will install all dependencies across all packages (e.g. ./, ./src, etc).

Read more about this in 0. Getting Started > 2. Tooling;

Setup /src directory

First, ensure you're within the /src directory:

cd src

Create a .env file by copying the .env.dist file, then edit this with your own values, or get them from another developer:

cp .env.dist .env

And lastly ensure you've installed the node modules using pnpm:

pnpm install

This will install dependencies in all directories listed as packages in pnpm-workspace.yaml.

Start up

The app has two build modes: development and production.

Start the dev server for watching and hot module reloading:

pnpm dev -o 
# The -o flag opens a new browser window automatically. Remove if you already have a window open

Or build for production and run the production server:

pnpm build
pnpm start

Next Steps

Now that you're up and running, you are ready to start building more of this application.

Or learn more about what's included in this starter repo: