# classpip-utils

> Mobile Application for School Gamification

Latest version **1.0.5** (published 2017-02-05) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install classpip-utils
pnpm add classpip-utils
yarn add classpip-utils
bun add classpip-utils
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2017-02-05 |
| First published | 2016-09-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ferran Vila |
| Maintainers | ferranvila |

## Links

- npm: https://www.npmjs.com/package/classpip-utils
- Repository: https://github.com/classpip/classpip-utils
- Homepage: https://github.com/classpip/classpip-utils#readme
- Issues: https://github.com/classpip/classpip-utils/issues
- npm.io page: https://npm.io/package/classpip-utils

## Recent versions

- 1.0.5 (latest) — 2017-02-05
- 1.0.4 — 2017-02-04
- 1.0.3 — 2016-09-14
- 1.0.2 — 2016-09-14
- 1.0.1 — 2016-09-14
- 1.0.0 — 2016-09-14

## README

# Classpip Utils Library

[![Classpip Badge](https://img.shields.io/badge/classpip-utils-brightgreen.svg)](https://github.com/classpip/classpip-utils)
[![Build Status](https://travis-ci.org/classpip/classpip-utils.svg?branch=master)](https://travis-ci.org/classpip/classpip-utils)
[![Npm version](http://img.shields.io/npm/v/classpip-utils.svg)](https://www.npmjs.com/package/classpip-utils)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e45e2915ec524d8bb286558f56f4c74b)](https://www.codacy.com/app/classpip/classpip-utils?utm_source=github.com&utm_medium=referral&utm_content=classpip/classpip-utils&utm_campaign=Badge_Grade)
[![Coverage Status](https://coveralls.io/repos/github/classpip/classpip-utils/badge.svg?branch=master)](https://coveralls.io/github/classpip/classpip-utils?branch=master)

[![classpip-icon](https://github.com/classpip/classpip/raw/master/resources/icontext-land.png)](http://www.classpip.com/)

[Classpip](https://www.classpip.com) is a Mobile application for School Gamification. The application is builded around a stack of services and websites to provide a full experience in order to gamificate any educational environment.

## Description

This repository contains a utils library written in Typescript that defines angular 2 elements for using in the classpip applications (desktop and mobile). This library is organized in:

- **components**: A component is what you used to call a directive in AngularJS. It contains a template, styles, a list of injectables (directives, services) and a selector.
- **directives**: Directives allow you to attach behaviour to elements in the DOM. It is also what you used to call a directive in AngularJS, but without a proper view. You can therefore place as many directives as you want on one DOM-element. This is not possible with components.
- **pipes**: A pipe in Angular2 is the equivalent of filters in AngularJS. As in AngularJS, pipes can be stateless (pure functions, not reevaluated) or stateful (has dependencies that can modify the output).
- **services**: Service is a broad category encompassing any value, function, or feature that your application needs. Almost anything can be a service. A service is typically a class with a narrow, well-defined purpose. It should do something specific and do it well.

## Installation

This library is published in [npmjs](https://www.npmjs.com) as **classpip-utils**. You can find the main page [here](https://www.npmjs.com/package/classpip-utils). For installing this library in your project you could run:

```
npm install classpip-utils --save
```

Once you have your library into the ```node_modules``` directory, you should include the ```UtilsModule``` into the NgModule of your application.

```script
> app-module.ts
import { UtilsModule } from 'classpip-utils';
@NgModule({
  declarations: [...],
  imports: [
    ...
    UtilsModule
    ...
  ],
  bootstrap: [...],
  entryComponents: [...],
  providers: [...]
})

> some-component.ts
import { DatePipe } from 'classpip-utils';
```

### Compile your code

The library is writter in Typescript, to generate the valid Javascript files for importing into another project you have to use the angular compiler and run the following command:

```
npm run ngc
```

### Validation

The library includes some validation rules for linting the typescript code. To run this validation rules, you have to run:

```
npm run tslint
```

## License

Classpip is released under the [Apache2 License](https://github.com/classpip/classpip-mobile/blob/master/LICENSE).

---
_Source: https://npm.io/package/classpip-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._