Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.95 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.95 KB
Raw

A preact-cli Template

Lighthouse-Badge

Documentation

  • This is an opinionated template for preact-cli.
  • For Preact: General information about how to work with Preact, not specific to this template

This template used the default template as the starting point but uses StandardJS and Workbox.

Usage

$ npm install -g preact-cli
$ preact create default my-project
$ cd my-project
$ npm install
$ npm run dev

Development server runs on port 8080. If the default port is already in use on your machine it will start the development server on a random port.

Commands

  • npm run dev: Run a development, HMR server

  • npm run serve: Run a production-like server

  • npm run build: Production-ready build

  • npm run lint: Pass JavaScript files using ESLint

  • npm run test: Run Jest and preact-render-spy for your tests

How to Test

The default template provides a basic test setup with Jest and preact-render-spy. You are free to change preact-render-spy with any other assertion library. The advantage of it is that it supports a similiar terminology and feature set as the Enzyme library for testing React applications.

You can run all additional Jest CLI commands with the npm run test command as described in the Jest docs. For example, running jest in watch mode would be :

  • npm run test -- --watch instead of jest --watch

Fork It And Make Your Own

You can fork this repo to create your own boilerplate, and use it with preact-cli:

preact create username/repo my-project