Skip to content

diescake/igata

Repository files navigation

[deprecated] igata

logo

CircleCI Netlify Status Renovate Storybook

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

'boilerplate'
|> toJapanese // 鋳型
|> toAlphabet // igata 🎉

DEMO

How to use

Recommend to use as a template. Please click above "Use this template" button to start. Though the template function provided by GitHub is really comfort and useful, please note that your new repository is always created from HEAD of master.

About template for more information, see Creating a repository from a template

How to build and launch server

$ yarn # npm install
$ yarn start # npm start

Requirements

  • Node.js v10.17.0
    • Probably the newer version is also fine.
  • Recommend to use version manager asdf.

Technology stacks

Languages

Single page applications

Styles

Utilities

Static code analysis and formatters

Tests

Buildings

DevOps

Editors

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)