Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.55 KB

README.md

File metadata and controls

52 lines (35 loc) · 2.55 KB

KILLBILL Custom API

This is a RESTful API built with Node.js Express, designed to serve CUSTOM data from Killbill's database to the Fleet-Towit client. It handles only the GET operation to avoid conflicts with Killbill's internal event chain. It can handle requests for one or multiple resources, and complies with Killbill's authentication system.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  1. You need to have Node.js and Docker and docker-compose installed on your machine.
  2. Config your the follow Docker machine ( Guide 4 running Kill Bill )

Installing

  1. Clone the repository
  2. Clone .env.example and rename for .env then fill the values with your Kill Bill stacks:
  3. Install the dependencies with npm install
  4. And Happy coding :)

Running the app

You can run the app with the following npm script:

npm start

For development, you can use:

npm run dev

Running the tests

You can run the tests with the following npm script:

npm test

Built With

  • @prisma/client: Prisma Client is an auto-generated database client that enables type-safe database access and reduces boilerplate. You can use it as an alternative to traditional ORMs such as Sequelize, TypeORM.
  • express: Fast, unopinionated, minimalist web framework for Node.js
  • swagger-jsdoc: Generates swagger doc based on JSDoc.
  • swagger-ui-express: This module allows you to serve auto-generated swagger-ui generated API docs from express, based on a swagger.json or swagger.yaml file.
  • chai: Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.
  • chai-http: Plugin for Chai to allow HTTP integration testing with Chai assertions.
  • mocha: Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun.
  • supertest: SuperTest is a super-flexible library that allows you to test HTTP servers using a fluent API.