AdventureClub Design System (React)
Experimental front-end design system with React.
Features (TODO)
- Fully customizable via SaSS
- Large collection of components for different solutions
- Powerful and flexible API
- Animation made easy
- Few dependencies (only
classnames
and lodash
)
Technology usage
Repository structure
index.ts
: uncompiled single entry of library, consumed by webpack/rollup projectsreset.scss
: style resetvariables.scss
: SaSS variablesmixins.scss
: SaSS mixinscomponents
: UI componentsdist
: compiled JS & CSS of library, consumed by other types of projectsdemo
: demo application
Development Guide
Recommended editor set-up
Visual Studio Code
Extensions:
- EditorConfig
editorconfig.editorconfig
- GitLens
eamodio.gitlens
- Prettier
esbenp.prettier-vscode
- stylelint
shinnn.stylelint
- tslint
ms-vscode.vscode-typescript-tslint-plugin
Start demo with hot-load
npm install
npm start
Build library
npm run build
Build demo application
npm run demo:build
License
GNU Affero General Public License version 3 or higher.
Credits