Voltra Hub Server

A server for the Voltra Hub API.

Features

• OpenAPI definition
• Compliant server setup
• NPM package generation for seamless API development
• Handle ESIOS REE PVPC API without authentication

Docker Setup

A docker image is available on Docker Hub

All environment variables are optional and will start on 8080 by default. Will use memory database by default.

Usage

docker run -d \
  -p 8080:8080 \
  -e PORT=8080 \
  -e MONGODB_URI=mydatabase.example.com \
  -e MONGODB_DATABASE=voltrahub
  xutyxd/voltra-hub-server

Quick Start Guide

1. Clone the repository:

   git clone https://github.com/xutyxd/voltra-hub-server
   cd voltra-hub-server
   

2. Install dependencies:

   npm install

3. Generate OpenAPI definition:

   npm run openapi:bundle
   npm run openapi:types
   npm run openapi:docs

4. Run the tests:

   npm run test:ts
   npm run test:units
   npm run test:functionals

5. Run the server:

   npm run start:local

Dependencies

Check dependencies for more documentation

• Node.js (v21.6.2)
• npm (v9.6.1)
• SoE (v1.6.1)
• InversifyJS (v6.0.2)
• OpenAPI Fetch (v0.12.0)
• Ajv (v8.17.1)
• MongoDB (v6.0.1)
• ESIOS API Client (v1.1.6)

License

This project is licensed under the AGPL-3.0 license - see the LICENSE file for details

Made with ☕ by XutyXD