SPeeSimon / smapi

FlightGear scenemodels API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

REST API for the scenemodels database

FlightGear logo V2.0

Description

This app contains REST endpoints to the FlightGear scenemodels database.

Development

Create a .env file from .env.template and fill in the properties.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

When the app is running, you can view a list of endpoints at http://localhost:3000/api/

The OpenAPI model is available in JSON format at http://localhost:3000/api-json

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Build with

About

FlightGear scenemodels API


Languages

Language:TypeScript 99.4%Language:Dockerfile 0.4%Language:HTML 0.2%