The front end framework for an Indix experience
All Indix apps need to provide consistent experience for users from a branding, look and feel. To accomplish this, developers need a framework that can be used across the company.
This is the visual guide to all experiences.
Using components from The Vision project
Visit oss.indix.com/the-vision for documentation on how to use the components in the framework.
Dev setup to run the project locally
- Checkout the code.
- Sets up git hooks
pre-commitruns the build and adds it before/for every commit
nvm useto switch to the right node version.
npm installto install all the dependencies. This may take a while.
bundle installto install a few dev-dependencies (Middleman).
If the previous step fails, install the correct version of ruby. We suggest using rvm gemsets.
- Fire up using
- Open localhost:4561 to view the app.
- Changes to the source code auto-refreshes the browser.
- In a parallel window, run
npm run developto run webpack in watch mode. This bundles the js file.
Publish a new component
- Add tests
- Add docs
- Update version
- Send a PR
Update the webpage
npm run publish-page -- "<commit msg>" to push the static files to