Clone the repository, install dependencies with package manager of your choice and you should be good to go. See deployment for notes on how to deploy the project on a live system.
Installing Yarn
Read the Installation Guide on Yarn website for detailed instructions on how to install it.
Installing Npm and Node
Read the Installation Guide on Npm website for detailed instructions on how to install it.
In the project directory, you can run:
npm start or yarn start
Runs the library in development mode. Open http://localhost:3000 to view it in the browser.
npm run test or yarn run test
Runs the test watcher in an interactive mode.
npm run build or yarn build
Builds the library for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
Deployment is done automatically by Travis.
- React - The component framework used
- Bulma - Style sheet framework wrapped
- Yarn - Dependency Management
- Typescript - Language used to develop the lib
- Jest - Test framework used
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Bruno Magalhães - Initial work - Klougod
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details