/template-www

Starter template for `www` projects.

Primary LanguageTypeScript

🛑 Note: I am no longer using this template. It has been archived.

Template

This is where you will put the one-line description of your awesome project.


Summary and features

Here you will put a more detailed description of the project.

  • project goals
  • important features

Getting started

Install system dependencies

To get going with this project you will need to install the following software:

  • Node (LTS)
  • overmind: enables running end-to-end tests and development server in parallel

Install project dependencies

Install project dependencies with: npm ci (clean-install)

Note: if you run into issues with npm ci, you can try npm install.

Verify everything is working as expected

  • Run unit tests: npm test
  • Run end-to-end tests: npm run cypress:open

Running the development server

  • I typically use the end-to-end test runner while developing: npm run cypress:open
  • But, if you prefer, you can forego the e2e and run the development server on its own: npm run dev

Update Auto-Generated Types

  1. Start the development server: npm run dev
  2. Generate them types: npm run generate:types