Skip to content

GrandlineX/skeleton-project

Repository files navigation

skeleton-project

GrandLineX Express-Kernel Skeleton project

Includes

  • Full Typescript project setup
  • Jest test and coverage config
  • ESLint config with AirBnB & Prettier presets
  • Example Kernel Extension code @/src

Quick Start

  1. Clone git clone https://github.com/GrandlineX/skeleton-project.git && cd skeleton-project
  2. Install dependencies npm install
  3. Build project npm run buildprep;
  4. Build project npm run start;

Additional commands

Command Description
npm run lint start ESLint
npm run test start Jest test collection (creates db entry's)
npm run test-converage start Jest test collection + coverage report (creates db entry's)
npm run start-dev start dev script with disabled cors
npm run makeDocs generates Typedoc documentation
npm run serveSpec Serve your Backend schema with Swagger-Ui
npm run buildSpecMain Build a js connector with types from your schema