A web development ui kit library for React.Js by emresandikci
Notice: it's still on development
First of all you have to install these plugins to your editor (vscode), but if you are using an another code editor or IDE install them for your dev environment
If you don't use one of these Code Editor/IDE please check is your EDITOR/IDE exist or not please install Editor Config plugin for your Code Editor/IDE.
While developing this library you should take an attention to linter rules, all of your codes and commit messages, because you can't do any development without checking by rules.
Notice: Before commit to changes, HuskyJs checking these commit messages / linter rules
If you get a lint's error when you commiting a message, you can check for eslint linter rules or if you get an error because of your commit message you can check below commit message types and examples or you can check from Conventional Commits.
Examples:
git commit -m "feat: navbar component added"git commit -m "docs(readme): server link added"- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
- chore: Updating packages,build project etc. (no production code change)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature, when refactoring a production code, eg. renaming a variable.
- revert: A commit revert message
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
I use storybook to documented the ESDUCAD UI kit
To get this repo to your local development enviroment, run the below script in your terminal and Ta daa, its running !!!
git clone https://github.com/emresandikci/esducad-ui && cd esducad-ui && yarn install && yarn start