This repository has been archived by the owner on Apr 9, 2022. It is now read-only.

next-ts-boilerplate

This is a boilerplate project which uses:

Next.js as the frontend framework
Jest for unit testing
Cypress for integration testing
CircleCI and/or GitHub Actions for continuous integration
Now for serverless continuous deployment
Now dev for local development
Tailwind with PurgeCSS as the CSS framework
TypeScript where possible

Still to investigate

Add caching to GitHub Actions so that it runs faster

What to customise when cloning

Update the LICENSE.txt
Update name, description, author, and repository in package.json
Update name and alias in now.json
Update title and description in pages/_app.tsx
Clean up the README, removing most of the stuff above

Installation and usage

Install the required version of node using nvm:

nvm <.nvmrc

Install dependencies:

yarn

Run locally:

yarn now dev
open http://localhost:3000

Deploy:

yarn deploy

Run jest unit tests:

yarn jest

Run cypress end to end tests:

yarn cypress open # Interactive test runner
# or
yarn cypress run # Headless

License