usabilla-assignment
A sample react assignment. Feel free to fork, copy and modify as needed.
Example
See https://clenemt.github.io/usabilla-assignment/ for a look at the code live. 🚀
How to
To run the sample locally, do the following:
npm install
npm run start
It will install dependencies and launch a small server at localhost:9000.
Explanation
It only runs thanks to:
- webpack-dev-server for the simple http server
- axios for the promise based HTTP client
- store.js for the Cross-browser storage API
- fuse.js for the fuzzy-search library
Most of the user actions (page, search, sort, filter) are saved to local storage and restored when you reload for a better UX.
Try clicking the nav for some easter egg.
Tests only runs thanks to:
Guidelines
- Prettier is used for style consistencies in all files
- ESlint is used for linting the
.js
files - EditorConfig is used to enforce correct spacings on all files
- The above is enforced when you try to commit
- Commits should be in the form of:
<emoji> <title>
# 📝 Update README.md
# ✅ Add unit test for inputs
For ease of use you can use the template provided above. The following command will add it as default for this repo only:
git config commit.template .gitmessage
Contributing
To make a build for github pages, do the following:
npm run build
Make sure all the tests succeeds before you do so:
npm run test
Check the created bundles for inconsistencies with:
npm run stats
License
Licensed under MIT.