Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/diescake/igata
[deprecated] igata is my boilerplate for Web Frontend.
https://github.com/diescake/igata
boilerplate react redux typescript
Last synced: about 2 months ago
JSON representation
[deprecated] igata is my boilerplate for Web Frontend.
- Host: GitHub
- URL: https://github.com/diescake/igata
- Owner: diescake
- License: mit
- Created: 2019-01-15T02:24:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T10:08:06.000Z (5 months ago)
- Last Synced: 2024-04-22T11:55:27.639Z (5 months ago)
- Topics: boilerplate, react, redux, typescript
- Language: TypeScript
- Homepage:
- Size: 9.21 MB
- Stars: 37
- Watchers: 3
- Forks: 7
- Open Issues: 111
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [deprecated] igata
[](https://circleci.com/gh/diescake/igata)
[](https://app.netlify.com/sites/igata-storybook/deploys)
[](https://renovatebot.com)
[](https://igata-storybook.netlify.com/)
`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.
```exs
'boilerplate'
|> toJapanese // 鋳型
|> toAlphabet // igata 🎉
```
## DEMO
- [Web Application](https://igata-diescake.netlify.com)
- [Storybook](https://igata-storybook.netlify.com/)
## How to use
Recommend to use as a template. Please click above ["Use this template"](https://help.github.com/en/articles/creating-a-repository-from-a-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](https://help.github.com/articles/creating-a-repository-from-a-template)
## How to build and launch server
```sh
$ 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](https://github.com/asdf-vm/asdf).
## Technology stacks
### Languages
- [TypeScript](https://www.typescriptlang.org/)
### Single page applications
- [React](https://reactjs.org/) + [Redux](https://redux.js.org/)
- [react-router](https://reacttraining.com/react-router/) + [connected-react-router](https://github.com/supasate/connected-react-router)
- [redux-saga](https://github.com/redux-saga/redux-saga)
### Styles
- [Sass](https://sass-lang.com/) as CSS Modules
- [clsx](https://github.com/lukeed/clsx)
- [Font Awesome](https://fontawesome.com/)
- [Reboot.css](https://raw.githubusercontent.com/twbs/bootstrap/v4-dev/dist/css/bootstrap-reboot.css)
### Utilities
- [axios](https://github.com/axios/axios)
- [dayjs](https://github.com/iamkun/dayjs)
- [Formik](https://jaredpalmer.com/formik/)
### Static code analysis and formatters
- [ESLint](https://eslint.org/) + [Prettier](https://prettier.io/)
- [stylelint](https://stylelint.io/)
### Tests
- [Jest](https://jestjs.io/)
- [StoryBook](https://storybook.js.org/)
### Buildings
- [yarn](https://yarnpkg.com)
- [webpack](https://webpack.js.org/)
### DevOps
- [webpack-dev-server](https://github.com/webpack/webpack-dev-server)
- [CircleCI](https://circleci.com/)
- [netlify](https://www.netlify.com)
- [Renovate](https://renovate.whitesourcesoftware.com/)
### Editors
- [Visual Studio Code](https://code.visualstudio.com/) (Recommended)
## Npm scripts
```sh
$ 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](https://github.com/diescake/igata/blob/master/LICENSE)
## Author
Daisuke Kondo (a.k.a [diescake](https://twitter.com/diescake))