Command Line Commands
yarn setup --project=project_name
Initializes a new project with this boilerplate. Deletes the
git history, installs the dependencies and initializes a new repository.
Note: This command is self-destructive, once you've run it the init script is gone forever. This is for your own safety, so you can't delete your project's history irreversibly by accident.
Starts the development server running on
Deletes the example app, replacing it with the smallest amount of boilerplate code necessary to start writing your app!
Note: This command is self-destructive, once you've run it you cannot run it again. This is for your own safety, so you can't delete portions of your project irreversibly by accident.
Allows you to auto-generate boilerplate code for common parts of your
containers. You can
yarn generate <part> to skip the first selection. (e.g.
yarn generate route)
Starts the development server and makes your application accessible at
localhost:random_port. Changes in the application code will be hot-reloaded.
- Runs tests (see
- Builds your app (see
- Starts the production server (see yarn start:prod)
The app is built for optimal performance: assets are minified and served gzipped.
Prepare your app for deployment on environment that is not production (does not run tests). The code has base optimization
and is not minified. All files are piping them to the
Upload the contents of
build to your web server to see your work live!
See the testing documentation for detailed information about our testing setup!
Tests your application with the unit tests specified in the
throughout the application.
test commands allow an optional
-- [string] argument to filter
the tests run by Jest. Useful if you need to run a specific test only.
# Run only the Button component tests yarn test -- Button
Watches changes to your application and re-runs tests whenever a file changes.
Starts the development server and tunnels it with ngrok, making the website available worldwide. Useful for testing on different devices in different locations!
Dependency size test
This command will generate a
stats.json file from your build, which you can
locahost:9001 with webpack jarvis.
This analyzer will visualize your dependencies and chunks with detailed statistics
about the bundle size.
yarn lint:eslint:fix -- .
Lints your code and tries to fix any errors it finds.
Prepare your app for deployment. That command includes linting and testing. Optimizes and
minifies all files, piping them to the
dist folder. If one of between lint or test fails,
the process stopped. Upload the contents of
dist to your web server to see your work live!