README.md

NeeV

From the Hindi word, meaning Foundation.

A collection of VueJS components based off the Zurb Foundation for Sites framework. Each component shall be completely configurable using props.

The component collection is still in the early stages of development and what may work one day, may not work the next. Please don't use in production for the time being as we'd hate for any breaking changes to affect you.

Requirements & Installation

The basic requirements for installing NeeV are NodeJS & NPM (or Yarn).

All of the package dependencies are managed by NPM (or Yarn), so to install these just run:

# install dependencies
npm install

# or
yarn install

Development

To start a development server, with hot reload, run:

npm run dev

Building for Production

When building for production, you can produce a fully minified build using:

npm run build

Additionaly, if you would also like to view the analyzer report when building, simply append the --report flag to the command, like so:

npm run build --report

Testing

To run the basic unit tests, use:

npm run unit

For end to end testing, run:

npm run e2e

To run all tests, then it's:

npm run test