davi-mbatista / snowpack-starter Goto Github PK

A simple and yet modern (opinionated) development environment template

• Snowpack
• Preact (optional, you can't completly ignore it)
• Typescript
• Jest
• Playwright
• Testing library
• Lighthouse CI
• Prettier
• GitHub Actions

• Extended testing capabilities with Jest, Playwright, and Testing library
• Lighthouse CI integration
• Grouped configuration files that keeps the root folder and package.json less crowded
• Fast (supports HMR with Snowpack)

• start: initializes the development server using Snowpack
• build: creates a production ready build of the source files with Snowpack
• serve: builds and serves the source files (mostly used for e2e tests)
• test: executes all available testing commands (unit, e2e, lighthouse)
  • test:unit: runs test files with Jest
  • test:e2e: runs e2e test files with Playwright (using [jest-playwright]) against Chrome, Firefox, and Safari
  • test:lighthouse: runs Lighthouse CI on the build source files (playwright))
• lint & format: runs Prettier on the src/ folder (and ignore the files set in the .prettierignore configuration).
• prepare: initializes the dependencies and modules with Snowpack. This command is automatically executed when you run npm install

For configuration details check the specific files under the config/ folder

This template comes with a built-in GitHub actions workflow that will execute tests on every push to the branch. For more details check the .github/workflows/ci.yml file.

If you're using vscode, please keep in mind that this template has specific configuration files that will be used when you open it on vscode. The configuration file is mostly necessary to point the editor to the correct location of the Prettier configuration file at /config/prettier.config.js.