single-page-app v0.1.1

Core components, framework & styles to be used by Yello Single Page Apps

Package

Getting started:

1. git clone git@code.yello.co:yello_enterprise_front_end/single-page-app.git

Local Development

1. cd {single-page-app}
2. npm install
3. npm run build` to init the app
4. npm run start # watch the app/ directory and push updates to dist/
5. navigate to http://localhost:8080/

Tasks

• npm run build will run the build only. This is useful to compile the code for deployment.
• npm run start will compile JSDocs, start the local dev server, and watch for local changes on port 8080. Note that JSDocs does NOT watch for changes. To update it run npm run jsdoc.
• npm run test:snapshots runs jest snapshot tests.
• npm run test:snapshots:replace runs and replace jest snapshot tests.
• npm run lint runs the stylelint and eslint tasks.
• npm run eslint runs eslint task only
• npm run stylelint runs stylelint task only
• npm run storybook runs storybook on port 6006
• npm run jsdoc compiles JSDocs and places them in dist/jsdoc. Can be accessed when dev server is running at http://localhost:8080/jsdoc/.

• npm run jsdoc:verbose complie JSDocs with verbose output.