@ngbelatrix/tooltip v0.0.0-beta-1

tooltip Angular 4 >

A complete, yet simple tooltip.

Quick start

# clone our repo
$ git clone https://gitlab.com/BSFfrontend/tooltip.git

# change directory to your app
$ cd tooltip

# install the dependencies with npm
$ npm install

# start the server
$ npm start

go to http://localhost:3001 in your browser.

Table of Contents

• Getting Started
  • Dependencies
  • Installing
  • Developing
  • Testing
  • Production
• TypeScript
• License

Getting Started

Dependencies

What you need to run this app:

• node and npm (Use NVM)
• Ensure you're running Node (v6.x.x+) and NPM (3.x.x+)

Installing

• fork this repo
• clone your fork
• npm install @belatrix/tooltip to install all dependencies

Developing

After you have installed all dependencies you can now start developing with:

• npm start

Testing

1. Unit Tests

• single run: npm test
• live mode (TDD style): npm run test-watch

Production

To build your application, run:

• npm run build

You can now go to /dist and deploy that to your server!

TypeScript

To take full advantage of TypeScript with autocomplete you would have to use an editor with the correct TypeScript plugins.

Use a TypeScript-aware editor

We have good experience using these editors:

• Visual Studio Code
• Webstorm 11+
• Atom with TypeScript plugin
• Sublime Text with Typescript-Sublime-Plugin

License

MIT