Shared Components for Aglet.io
This project requires Node.js. Ensure that you have the latest version installed before continuing.
This project uses a webpack server with hot module replacement for development.
Clone repo: git clone git@github.com:luetkemj/aglet-components.git
Install dependencies: yarn or npm install
Start the server: npm start
Navigate to localhost:3000
This project uses jest for unit tests, code coverage reports, and component snap shots.
To run tests in watch mode: npm run test:watch
To run lint all code and run all tests: npm run test
This project uses eslint-airbnb. Custom rules can be found in the .eslintrc file included in this project.
eslint: npm run lint:eslint
This project uses sass-lint. Custom rules can be found in the .sass-lint.yml file included in this project.
sass-lint npm run lint:sass-lint
eslint and sass-lint: npm run lint
Contributions are welcome.
Find a bug? Open an issue!
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub