plainweb

# Getting Started

Run the following command to create a new plainweb starter project:

npx create-plainweb

You need Node and pnpm installed. plainweb uses Node 20.10.0 or higher and pnpm 9.5.0 or higher.

node --version
> v20.10.0

pnpm --version
> 9.5.0

Start the development server at http://localhost:3000.

pnpm run dev

# Commands

These are the most important commands for development:

  • pnpm run dev runs the development server in watch mode
  • pnpm run test runs tests with the built-in Node test runner (Node 22 is recommended)
  • pnpm run db:gen generates the migration files
  • pnpm run db:apply applies the migrations
  • pnpm run build type checks your app and minifies the CSS
  • pnpm run routes prints all express routes to the console
  • pnpm run check runs the linter, formatter and scans .tsx files for cross-site scripting

# VSCode Extensions

Following extensions are recommended when using VSCode:

# Next steps

Head over to Directory Structure to dig into the starter project.