TweenRex Debug
This project contains debugging tools for the TweenRex project.
Questions / Documentation
Please go to TweenRex to ask questions and find documentation.
Contributions
Contributions are welcome. Please create an issue on the main TweenRex project prior to adding a Pull Request on this project. See below on how to run this project locally.
How to get the project running locally
- Install NodeJS / NPM.
- Clone this project.
- Run
npm install
in the directory. - Run
npm start
to debug the tools in the browser. This will build to thetests
. - Run
npm run build
to build the tools locally.
Structure of the project
Folder | Description |
---|---|
/lib | Output for node package |
/src | Source files for components |
/tests | Live test web site |
/types | TypeScript type definitions |
Before you submit a Pull Request for code
- Submit an issue on the main TweenRex project
- Ensure at least one new visual test to cover new tools
- Ensure new files are formatted property (4 space indentation)
License
This library is licensed under MIT.