https://github.com/katmai7/reason-react-rollup-starter-kit
Reason-react starter kit
https://github.com/katmai7/reason-react-rollup-starter-kit
reason-react rollup starter-kit
Last synced: about 1 month ago
JSON representation
Reason-react starter kit
- Host: GitHub
- URL: https://github.com/katmai7/reason-react-rollup-starter-kit
- Owner: katmai7
- License: mit
- Created: 2018-02-10T16:30:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-17T13:35:17.000Z (about 7 years ago)
- Last Synced: 2024-12-24T23:28:45.448Z (5 months ago)
- Topics: reason-react, rollup, starter-kit
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Reason-react starter kit
[](https://opensource.org/licenses/MIT)
Reason starter kit for creating react library.
## Getting started
Clone this repository and install its dependencies:
```bash
git clone https://github.com/katmai7/reason-react-rollup-starter-kit.git
cd reason-react-rollup-starter-kit
yarn install
```
## NPM scripts
- `yarn dev` build lib in dev mode
- `yarn build` build lib for production
- `yarn example` run example server
- `yarn test` run tests
- `yarn clean` cleaning project
### Development
Running the following command will open your default browser to `example/index.html`.
Any modifications inside `./src` trigger a browser refresh.
```bash
yarn dev
```
### Production
Running the following command will build `./src/index.re` to `./dist/your_lib_name.(cjs|es6|umd).js`.
```bash
yarn build
```
### Example app
The example app is running with the webpack as one of the main builders for web apps.
Note that example app needs to build `./src/index.re` file, so before running the example app, run `yarn dev`.
```bash
yarn dev
yarn example
```
### Testing
Running the following command will run tests with Jest framework.
```bash
yarn test
```
### Cleaning
Running the following command will clean project folders that are created by bucklescript and dist/temp/(folders you don't need to commit) folders.
```bash
yarn clean
```
## License
MIT