Aksara UI is an open source, so every component in Aksara UI is developed by your help. You too can help contribute to this project! This page describes how to setup the project on your computer for local development.
This project is bound by a Code of Conduct.
The simple steps of contributing to any GitHub project are as follows:
- Fork the repository
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push -u origin my-new-feature - Create a Pull Request!
To keep your fork of in sync with this repository, follow this guide.
For members of the Kata.ai organisation, or if you have push access to this repository, just clone directly from the repo and push your branches here. It's fine.
- Git
- Node.js (10.0.0+)
- Yarn (1.x)
- Text Editor with EditorConfig & Prettier support. (We recommend Visual Studio Code)
In general, contributors should use Node v10 and Yarn v1.x
Run these commands inside the Terminal (PowerShell/Command Prompt for Windows).
Git: You should see the version number:
$ git version
git version 2.18.0Node.js: You should see the version number:
Note that we use
.nvmrcin the root of this repository, to runnvm useautomatically please kindly follow this documentation
$ node -v
v10.17.0Yarn: You should see the version number:
$ yarn -v
1.9.4First, you should clone the repository that you forked.
$ git clone https://github.com/[your username]/aksara-ui.gitFor example:
$ git clone https://github.com/resir014/aksara-ui.gitAfter this repository has been cloned, cd into the repository:
$ cd aksara-uiInstall the project's dependencies. Note that we use Yarn, not npm:
$ yarnTo start developing components, you have to run the Storybook server.
$ yarn storybook
info Storybook started on => http://localhost:9001/The storybook server is available at http://localhost:9001. Note that any new component needs to have at least one story as a demo, and some tests.