/TMD

Tag My Docs

Primary LanguageTypeScript

Tag My Doc

Before I meet TMD, managing my documents was a nightmare. Today thanks to TMD, I feel joy in my heart and peace in my soul. TMD saved my life

(anonymous)

Quick Start

Get started developing...

# install deps
npm install

# run in development mode
npm run dev

# run tests
npm run test

.envfile :

APP_ID=api-ts
PORT=3000
LOG_LEVEL=debug
REQUEST_LIMIT=100kb
SESSION_SECRET=mySecret
UPLOAD_PATH=tmp/upload
CONTENT_ROOT_PATH=tmp/content

#Swagger
SWAGGER_API_SPEC=/spec

Install Dependencies

Install all package dependencies (one time operation)

npm install

Run It

Run in development mode:

Runs the application is development mode. Should not be used in production

npm run dev

or debug it

npm run dev:debug

Run in production mode:

Compiles the application and starts it in production production mode.

npm run compile
npm start

Test It

Run the Mocha unit tests

npm test

or debug them

npm run test:debug

Try It

  • Open you're browser to http://localhost:3000
  • Invoke the /examples endpoint 
    curl http://localhost:3000/api/v1/examples

Debug It

Debug the server:

npm run dev:debug

Debug Tests

npm run test:debug

Debug with VSCode

Add these contents to your .vscode/launch.json file

References

To Check