Vivi

A lightweight component-focused Javascript framework. Vivi is currently still in it's early stages, so breaking changes are more common. This package uses semantic versioning, so breaking changes will result major version updates.

Announcements

Typescript

Vivi has converted from Typescript to Javascript for better compatitbility. It's still possible to run Vivi.js with TS, but if you want to use the old version of Vivi that took advantage of a lot of TS-only features like decorators, you can find it in the Vivi-Typescript repo and under @cspruit/vivi-ts npm package.

Versioning

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 Update (Previously v3):

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!

Installation and Gettings Started

• Install by running npm install --save-dev @cspruit/vivi in 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.

Contributing

All contributions, suggestions, and issues are welcome!

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.

How to Contribute

1. Fork this repository
2. Create a branch: git checkout -b <branch_name>
3. 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.
4. Push to the original branch: git push origin https://github.com/CassandraSpruit/Vivi.git
5. Create a Pull Request

License

This project uses GPL 3.0.