# @energyweb/origin-device-registry-irec-local-api

> An API for local version of I-REC compatible registry

Latest version **1.2.1** (published 2022-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @energyweb/origin-device-registry-irec-local-api
pnpm add @energyweb/origin-device-registry-irec-local-api
yarn add @energyweb/origin-device-registry-irec-local-api
bun add @energyweb/origin-device-registry-irec-local-api
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2022-03-16 |
| First published | 2021-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 21 |
| Unpacked size | 162.3 KB |
| Known vulnerabilities | 0 (+8 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 110 |
| Author | EnergyWeb DevHub GmbH; Piotr Kosinski, piotr.kosinski@energyweb.org |
| Maintainers | kyleiankian, energywebdev, aznagy, bagaric, pkosin, drgorb, kroy, manihagh |

## Links

- npm: https://www.npmjs.com/package/@energyweb/origin-device-registry-irec-local-api
- Repository: https://github.com/energywebfoundation/origin
- Homepage: https://github.com/energywebfoundation/origin/tree/master/packages/origin-device-registry-irec-local-api#readme
- Issues: https://github.com/energywebfoundation/origin/issues
- npm.io page: https://npm.io/package/@energyweb/origin-device-registry-irec-local-api

## Dependencies (21)

- [rxjs](https://npm.io/package/rxjs.md) 7.4.0
- [ethers](https://npm.io/package/ethers.md) 5.3.1
- [typeorm](https://npm.io/package/typeorm.md) 0.2.41
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) 8.1.1
- [@nestjs/cqrs](https://npm.io/package/@nestjs/cqrs.md) 8.0.0
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) 8.1.1
- [@nestjs/config](https://npm.io/package/@nestjs/config.md) 1.0.2
- [@nestjs/swagger](https://npm.io/package/@nestjs/swagger.md) 5.1.4
- [@nestjs/typeorm](https://npm.io/package/@nestjs/typeorm.md) 8.0.2
- [class-sanitizer](https://npm.io/package/class-sanitizer.md) 1.0.1
- [class-validator](https://npm.io/package/class-validator.md) 0.13.2
- [@nestjs/passport](https://npm.io/package/@nestjs/passport.md) 8.0.1
- [@nestjs/schedule](https://npm.io/package/@nestjs/schedule.md) 1.0.1
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) 0.1.13
- [class-transformer](https://npm.io/package/class-transformer.md) 0.3.1
- [@energyweb/origin-backend](https://npm.io/package/@energyweb/origin-backend.md) 11.2.3
- [@energyweb/origin-backend-core](https://npm.io/package/@energyweb/origin-backend-core.md) 8.2.3
- [@energyweb/origin-backend-utils](https://npm.io/package/@energyweb/origin-backend-utils.md) 1.8.3
- [@energyweb/issuer-irec-api-wrapper](https://npm.io/package/@energyweb/issuer-irec-api-wrapper.md) 1.2.1
- [@energyweb/origin-device-registry-api](https://npm.io/package/@energyweb/origin-device-registry-api.md) 1.1.3
- [@energyweb/origin-organization-irec-api](https://npm.io/package/@energyweb/origin-organization-irec-api.md) 1.9.1

## Recent versions

- 1.2.1 (latest) — 2022-03-16
- 1.1.2-alpha.1658756736.0 (canary) — 2022-07-25
- 1.1.2-alpha.1658745615.0 — 2022-07-25
- 1.1.2-alpha.1657642980.0 — 2022-07-12
- 1.1.2-alpha.1654697952.0 — 2022-06-08
- 1.1.2-alpha.1651489311.0 — 2022-05-02
- 1.1.2-alpha.1651149594.0 — 2022-04-28
- 1.2.2-alpha.1650636678.0 — 2022-04-22
- 1.2.0 — 2022-03-15
- 1.1.2-alpha.1646656455.0 — 2022-03-07
- 1.1.2-alpha.1646058469.0 — 2022-02-28
- 1.1.2-alpha.1646056819.0 — 2022-02-28
- 1.1.1 — 2022-01-18
- 1.1.1-alpha.1642431088.0 — 2022-01-17
- 1.1.0 — 2021-12-30
- … 282 more at https://npm.io/package/@energyweb/origin-device-registry-irec-local-api/versions

## README

<p align="center">
  <a href="https://www.energyweb.org" target="blank"><img src="../../../docs/images/EW.png" width="120" alt="Energy Web Foundation Logo" /></a>
</p>

# Origin Device Registry IREC Local API

## Description

API for working with the I-REC implementation of device registry

The [Origin SDK](../../../README.md) is a component of the [Energy Web Decentralized Operating System](#ew-dos)

See a reference implementation of Origin deployed [here](https://origin-ui-canary.herokuapp.com/device/all)

## Installation

This is a Node.js module available through the npm registry.

### Requirements

//TO DO OR REMOVE

Before installing, download and install Node.js. Node.js xxx or higher is required.

Installation is done using the following commands:

```sh
$ yarn
```

## Build

```sh
$ yarn build
```

## Run

```sh
$ npm run start
```

## Testing (delete if not needed)

Testing Strategy

### Integration Tests (delete if not needed)

```sh
$ npm run test
```

## Documentation

-   [Origin Documentation](https://energy-web-foundation-origin.readthedocs-hosted.com/en/latest/)
-   [Device Management User Guide](https://energy-web-foundation-origin.readthedocs-hosted.com/en/latest/user-guide-device-management/)

## Contributing Guidelines

See [contributing.md](../../../contributing.md)

## Questions and Support

For questions and support please use Energy Web's [Discord channel](https://discord.com/channels/706103009205288990/843970822254362664)

# EW-DOS

The Energy Web Decentralized Operating System is a blockchain-based, multi-layer digital infrastructure.

The purpose of EW-DOS is to develop and deploy an open and decentralized digital operating system for the energy sector in support of a low-carbon, customer-centric energy future.

We develop blockchain technology, full-stack applications and middleware packages that facilitate participation of Distributed Energy Resources on the grid and create open market places for transparent and efficient renewable energy trading.

-   To learn about more about the EW-DOS tech stack and the energy-sector challenges our use cases address, see our [documentation](https://energy-web-foundation.gitbook.io/energy-web/).

For a deep-dive into the motivation and methodology behind our technical solutions, we encourage you to read our White Papers:

-   [Energy Web White Paper on Vision and Purpose](https://www.energyweb.org/reports/EWDOS-Vision-Purpose/)
-   [Energy Web White Paper on Technology Detail](https://www.energyweb.org/wp-content/uploads/2020/06/EnergyWeb-EWDOS-PART2-TechnologyDetail-202006-vFinal.pdf)

## Connect with Energy Web

-   [Twitter](https://twitter.com/energywebx)
-   [Discord](https://discord.com/channels/706103009205288990/843970822254362664)
-   [Telegram](https://t.me/energyweb)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

---
_Source: https://npm.io/package/@energyweb/origin-device-registry-irec-local-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
