https://github.com/waseemsabir/cloud-charging

https://github.com/waseemsabir/cloud-charging

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/waseemsabir/cloud-charging
• Owner: WaseemSabir
• Created: 2023-09-05T16:47:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-05T17:06:34.000Z (over 1 year ago)
• Last Synced: 2024-11-04T23:21:26.972Z (about 2 months ago)
• Language: TypeScript
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cloud Charging

This is a small TypeScript project that allows you to locally run the Cloud Charging engine. Do not worry if you are not familiar with TypeScript, the codebase is small and easy to follow. The bulk of the logic is in `backend/app.ts`.

Prerequisites:

 - Docker (https://docs.docker.com/get-docker/)

 - NodeJS 18 (https://nodejs.org/en/download/)

 - Code Editor (e.g., VSCode - https://code.visualstudio.com/)

Getting started:

 - Install the dependencies: `cd backend && npm ci`.

 - Run `docker-compose up --build` in the root folder of the stack to start the cache.

 - You can now adjust the code as needed.

 - Run `cd backend && npm start` to start the backend.

 - Check the requests.http for some examples of how to use the backend via the API. Optionally, you can use the [VSCode Rest Client plugin](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) to execute this file.

 - Run `cd backend && npm test` to run tests against the API to determine the current latency.