Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zzarcon/ts-react-toolbox
Opinionated toolbox boilerplate to create Typescript React components 🛠:package:
https://github.com/zzarcon/ts-react-toolbox
cli enzyme examples format formatter gh-pages jest lint prettier react static toolbox travis-ci tslint typescript typescript-react-components webpack webpack-dev-server
Last synced: about 2 months ago
JSON representation
Opinionated toolbox boilerplate to create Typescript React components 🛠:package:
- Host: GitHub
- URL: https://github.com/zzarcon/ts-react-toolbox
- Owner: zzarcon
- License: mit
- Created: 2018-03-09T08:53:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-03T09:25:52.000Z (about 1 year ago)
- Last Synced: 2024-11-11T19:07:07.494Z (2 months ago)
- Topics: cli, enzyme, examples, format, formatter, gh-pages, jest, lint, prettier, react, static, toolbox, travis-ci, tslint, typescript, typescript-react-components, webpack, webpack-dev-server
- Language: TypeScript
- Homepage:
- Size: 777 KB
- Stars: 23
- Watchers: 5
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-react-toolbox
> Opinionated toolbox boilerplate to create Typescript React components
# Install
```
pnpm add ts-react-toolbox -D
```
# Setup
After you have installed it, run this from the root of your package:
```
$ node_modules/.bin/ts-react-toolbox init
```
That will add all the boilerplate and scripts to your project
# Contains
* Typescript ✅
* React + ReactDom ✅
* Webpack + WebpackDevServer ✅
* Jest ✅
* Examples ✅
* StyledComponents boilerplate ✅
* Travis config ✅
* Static site generation with github pages ✅
* Prettier ✅
* ES5 support ✅
* ES2015 support ✅
* Git hooks ❌
* Bundle size analyzer ❌
# Folder structure
* `__tests__`
* `custom-typings`
* `example`
* `src`
# Commands
* **init**: Initializes project
* **dev**: webpack-dev-server
* **test**: jest + watch mode
* **build**: Typescript build
* **release**: build + run tests + version bump + publish to registry
* **static**: deploys example to github pages
* **lint**: TODO
* **format**: prettier
* **analyze**: webpack-bundle-analyzer
# Entry points
* **package.json**
```json
"main": "dist/es5/index.js",
"jsnext:main": "dist/es2015/index.js",
"module": "dist/es2015/index.js",
"types": "dist/es5/index.d.ts"
```
# Inspired by
Dan Abramov - The Melting Pot of JavaScript : https://www.youtube.com/watch?v=G39lKaONAlA
# Changeset
## 1.0.0
All the dependencies are bumped to the latest major version.
# TODO
* migrate to ESLint / Prettier
* replace Enzyme for RTL