A lightweight component-focused Typescript framework.
This version of Vivi will not be maintained extensively. For the latest updates, use the Javascript version.
Vivi is moving over to true automated semantic releases, so future update announcements and milestones will be groups of major feature updates and fixes.
Node tree milestone is complete and has been released! Some of the new changes:
- Dynamic loading for child components from the template, like adding a list of components based off an array
- Easier loading for child components from the component class
- Lots of component and template-related bugfixes! Yay!
- Smaller package size!
- Install by running
npm install --save-dev @cspruit/vivi-tsin the same directory as the package.json file lives. - Webpack is required to use Vivi's automatic template and style loading. For more detail, checkout the Getting Started page.
All contributions, suggestions, and issues are welcome!
Keep in mind, this version will only be lightly maintained and most of the feature updates will be in the Vivi repo.
Check out the Issues page. In general anything listed is up for grabs, though bugs tend to be more detailed than enhancements and might be better to pick up if starting out.
- Fork this repository
- Create a branch:
git checkout -b <branch_name> - Make your changes and commit using :
npm run commit- Please remeber to write tests, if applicable.
- You can run tests by running
npm run test. Or if you have jest installed, you can run it for specific files. - Note: There seems to be a bug with running code coverage along with debugging in VS Code. You can turn off coverage in the jest.config.js file by commenting "collectCoverage: true" out or setting it to false.
- Push to the original branch:
git push origin https://github.com/CassandraSpruit/Vivi-Typescript.git - Create a Pull Request
This project uses GPL 3.0.