React Slim CLI

A Simple lightweight CLI for building SPA applications and components in ReactJS

Usage

The following command used to initialize your ReactJS project is as follows:

react-slim-cli -c

react-slim-cli --create

The script will create all that's needed to run, build and test the project in whatever the current directory is.

Project Scripts

In order to build a SPA application, you have some optional commands: (NOTE: All scripts containing the word WATCH will trasnpile when files are changed)

npm run serve

This script will run browser-sync and transpile your files as they change so that you can actively develop and host your files for fast pace work. If you have a need to manually build the application, all of the necessary build scripts are listed below...

npm run build-watch-debug

This will deploy your bundled application to this dist folder. You can then preview the application in the index.html. This script will also deploy the raw, non transpiled JS files for debugging purposes.

npm run build-watch or npm run build

These scripts will also deploy your application except they will ONLY include transpiled code.

npm run test

This will use jest to execute all tests in the tests folder within the project and collect coverage. There is currently an example test file with tests around the app.js.

npm run quality

This will run a quality check on all JS files using ESLINT. There is an eslintrc.json file that can be edited with more or less specific rules if desired.

npm run package-component

This will transpile the files in the src folder and output the trasnpiled code to the lib directory. This is designed for creating npm packaged react components. WARNING: The package.json in the lib folder is an exact copy of the package.json in the root project and it will most likely need to be edited (ex: name, author, description, dependencies, etc.) to define the npm package you are intending to publish to https://www.npmjs.com.