/feathersjs-swagger-tests

Testing feathers swagger in action

Primary LanguageJavaScriptMIT LicenseMIT

feathersjs-swagger-tests-v5-koa

About

This is an example repository adding swagger documentation to the feathers-chat example application.

Application was generated with the feathers cli generator using the options:

  • koa
  • TypeBox

This project uses Feathers. An open source framework for building APIs and real-time applications.

Getting Started

  1. Make sure you have NodeJS and npm installed.

  2. Install your dependencies

    cd path/to/feathersjs-swagger-tests-v5-koa
    npm install
    
  3. Start your app

    npm run compile # Compile TypeScript source
    npm run migrate # Run migrations to set up the database
    npm start
    

Testing

Run npm test and all your tests in the test/ directory will be run.

Scaffolding

This app comes with a powerful command line interface for Feathers. Here are a few things it can do:

$ npx feathers help                           # Show all commands
$ npx feathers generate service               # Generate a new Service

Help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.