nickoneill / ts-preact-starter

Barebones starter project for Preact with TypeScript

ts-preact-starter

This is a barebones starter kit for Preact with TypeScript. Click the green "Use this template" button at the top of this page and enter a name and description for your repository.

To get up and running

1. npm install
2. From the command line run npm start
3. Navigate to http://localhost:3000

To run tests:

1. npm test
2. To run in watch mode, run npm run test:watch
3. Tests are set up to run out of the __tests__ folder. I put this by default as this appears to be part of the Jest defaults, but if you prefer to have your tests beside the code you want to test, simply modify the regex in the Jest configuration in package.json.

To run Cypress:

1. Run npm run start to start the webpack dev server.
2. Run npm run e2e:dev to open the Cypress test runner. For more information on Cypress, see their official documentation

To run Storybook:

1. npm run storybook
2. Navigate to http://localhost:6006
3. For more information on using Storybook, see the Storybook for Preact guide.

A deployed demo can be found at typescript-preact-starter.iamdeveloper.com.