example

example copied to clipboard

Example project written using Marble.js v2.0

The example project is written in version 2.x of Marble.js. The v3.0 rewrite will be available soon.

Requirements

In order to run tests locally, please install docker which containerizes the testing mongodb database.

Installation

$ cp ./src/config/env.ts.dist ./src/config/env.ts
$ yarn

Basic commands

$ yarn start           ## run server
$ yarn watch           ## run server in watch mode (development)
$ yarn build           ## build the app
$ yarn lint            ## lint TypeScript files
$ yarn test            ## run tests with coverage report
$ yarn test:watch      ## run tests in watch mode
$ yarn docker          ## start mongodb container

API doc

You can reach the actual API documentation here

License

marble.js is MIT licensed