About

Code duplication is a big issue. As developers move from from project to project we often copy and paste snippets of code between projects. While this is quick and easy its very hard to maintain.

This project is intended to act as a place where NodeJS developers can store and share useful snippets of code.

Usage

Install via npm as you would with any other package by supplying both the repo URL and branch or tag reference. In the example below the tag v0.0.1 is used.

npm i -S @bcgov/common-nodejs-utils

You can also directly add it to your package.json file by inserting the following line into your dependencies section:

"@bcgov/common-nodejs-utils": "git+https://[email protected]/bcgov/common-nodejs-utils.git#v0.0.1",

Once you installed you can can use it like any other module:

import { errorWithCode } from '@bcgov/common-nodejs-utils';

* You can also use the ssh protocol preferred.

Project Status / Goals / Roadmap

This project is active.

Getting Help or Reporting an Issue

Send a note to [email protected] and you'll get routed to the right person to help you out.

How to Contribute

Create a pull request with your code. Its really that simple.

* If you are including a Code of Conduct, make sure that you have a CODE_OF_CONDUCT.md file, and include the following text in here in the README:* "Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms."

License

Copyright 2018 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

common-nodejs-utils by the Province of British Columbia is licensed under a Creative Commons Attribution 4.0 International License.