mbeauv/urbanoe-common

[![Maintainability](https://api.codeclimate.com/v1/badges/e5acb41fa9167b59d8b5/maintainability)](https://codeclimate.com/github/mbeauv/urbanoe-common/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e5acb41fa9167b59d8b5/test_coverage)](https://codeclimate.com/github/mbeauv/urbanoe-common/test_coverage)

# urbanoe-common

Module defining base classes and functions for an urbanoe based client.  What you'll mainly find here a formatting methods that can be
used both on the web application or any of the mobile applications.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Installing

urbanoe-common is an npm module and can be downloaded from the npm registry.

Using npm:

```
npm i --save urbanoe-common
```

Using yarn:

```
yarn add urbanoe-common
```

### And coding style tests

If submitting code, please ensure that your code follows the eslint rules we use. Thanks.

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/mbeauv/214b791a2512201886e4833a3c64241f) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

## Authors

* **Martin Beauvais** - *Initial work* - [mbeauv](https://github.com/mbeauv)

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

## License

This project is licensed under the Apache v 2.0 License - see the [LICENSE.md](LICENSE.md) file for details