/appshell

Vitamin recipe for react + typescript PWAs

Primary LanguageTypeScript

Vitamin

codecov Test workflow CodeQL workflow Total alerts Language grade: JavaScript Up to date dependencies Up to date dev dependencies Cypress.io code style: prettier Commitizen friendly license

Opinionated Vite starter template.

Features

Getting started

Use this repository as a GitHub template or use degit to clone to your machine with an empty git history:

npx degit wtchnm/Vitamin#main my-app

Then, install the dependencies:

yarn install

Before you start coding

  • If you don't plan to use GitHub Actions, delete the .github directory.
  • Clean up the cypress/integration/index.spec.ts file.
  • Change the favicon.png, apple-touch-icon.png, android-chrome-192x192.png and android-chrome-512x512.png. favicon.io is a cool tool for generating these assets.
  • Remove the fruits.json in the public folder.
  • In the src folder, remove the api and components folder and the types.ts file.
  • If you don't plan to use react-query, remove the query client logic in the main.tsx file.
  • Change the title, description and theme color in the index.html and vite.config.ts. Inter font is included, so remove it if you want.
  • Modify or delete the LICENSE file.
  • Change the name field in package.json.

Development

Just run yarn dev.

Production

Run yarn build. The generated files will be on the dist folder.

Testing

Run yarn test. Tests are performed on production build, so be sure to build your app first.