/igata

igata is my boilerplate for Web Frontend.

Primary LanguageTypeScriptMIT LicenseMIT

igata

logo

CircleCI Netlify Status Dependabot Status Storybook

igata(鋳型) is my boilerplate for Web Frontend. It should be maintained by me and my lovely dependabot as much as possible. By the way, 鋳型 is a Japanese word and it means a boilerplate or casting mold.

DEMO

How to use

Recommend to use as a template. Please click above "Use this template" button to start. 😊

Technology stacks

Languages

View frameworks

Utilities

Styles

Tests

Buildings

DevOps

Requirement

  • Node.js v8.xx
    • Possibly the latest version is also fine.

Npm scripts

$ yarn                  # install dependencies
$ yarn start            # build and launch a development server
$ yarn build            # build and generate the production codes
$ yarn format           # format and save any codes with prettier
$ yarn lint             # lint source codes after format automatically
$ yarn style            # lint css and alt-css after format automatically
$ yarn test             # run the test codes using Jest framework
$ yarn test:watch       # run tests and watch for changes
$ yarn deploy           # deploy the production codes but currently not used
$ yarn license          # display summary of OSS licenses which are bundled in production codes
$ yarn storybook        # run the UI component test codes and launch a development server
$ yarn storybook:build  # generate the UI component docs using StoryBook

Note

Pre-commit tasks

Some tasks are kicked before committing by the combination of husky and lint-staged, but unfortunately they are NOT always called, so some developers may skip this check process as a result. As far as I know, some GUI git clients can ignore and skip the checking.

License

MIT License

Author

Daisuke Kondo (a.k.a diescake)