Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openchargingcloud/ocpiexplorerdesktopapp

An OCPI Explorer as an Electron Desktop App
https://github.com/openchargingcloud/ocpiexplorerdesktopapp

e-mobility evcharging evroaming ocpi openapi opendata

Last synced: about 2 months ago
JSON representation

An OCPI Explorer as an Electron Desktop App

Awesome Lists containing this project

README

        

# OCPI Explorer DesktopApp

This project implements the [**Open Charge Point Interface (OCPI)**](https://github.com/ocpi/ocpi) defined by the [EV Roaming Foundation](https://evroaming.org) using [Electron](https://www.electronjs.org), a cross platform Open Source framework for creating native applications with web technologies like Java-/TypeScript, HTML, and (S)CSS. The focus of this project is **testing** and **certification** of the OCPI protocol and 3rd party vendor extensions. This project supports the following protocol versions and extensions:

- [OCPI v2.1.1](https://github.com/ocpi/ocpi/tree/release-2.1.1-bugfixes) *(under development)*
- [OCPI v2.2.1](https://github.com/ocpi/ocpi/tree/release-2.1.1-bugfixes) *(under development)*
- [OCPI v2.3](https://github.com/ocpi/ocpi/tree/release-2.1.1-bugfixes) *(under development)*
- [OCPI v3.0](https://github.com/ocpi/ocpi/tree/release-2.1.1-bugfixes) *(experimental... there be dragons!)*

## Installation

Install the required Node.js modules...
```
$ npm install
```

## Debugging

In order to build SCSS styles, TypeScript, to bundle the Electron App using webpack, and to start in debug mode just enter:

```
./run.sh
```

Alternatively you can also start the app using a given OCPI Versions URL and an OCPI Acess Token, which might be BASE64 encoded before transmission.
All parameters are optional.

```
./run.sh --url=https://api.example.org/ocpi2.1/versions --token=abcd --nobase64
./run.sh --url=https://api.example.org/ocpi2.2/versions --token=abcd
```

## Start

In order to start without debugging:

```
electron .
```

Again you can also start the app using a given OCPI Versions URL and an OCPI Acess Token, which might be BASE64 encoded before transmission.
All parameters are optional.

```
electron . --url=https://api.example.org/ocpi2.1/versions --token=abcd --nobase64
electron . --url=https://api.example.org/ocpi2.2/versions --token=abcd
```

## Security

(Security) updates...
```
$ npm audit fix
$ npm update
```

Forced update of all Node.js modules...
```
$ ./update.sh
```

## License

[GNU Affero General Public License)](LICENSE)