thilak-rao / feathers-typescript-starter

A feathersjs starter app. Built using feathersjs, typescript and swagger for hackathons

feathers-typescript-starter

A feathersjs starter app. Built using feathersjs, typescript and swagger for hackathons

About

This project uses Feathers. An open source web framework for building modern real-time applications.

Getting Started

1. Make sure you have NodeJS, and yarn installed.

2. Clone the repo

   git clone --depth=1 https://github.com/xthilakx/feathers-typescript-starter.git
   

3. Install your dependencies

   cd feathers-typescript-starter; yarn install
   

4. Start your app

   yarn run start
   

Testing

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

Scaffolding

Feathers has a powerful command line interface. Here are a few things it can do:

$ npm install -g @feathersjs/cli          # Install Feathers CLI

$ feathers generate service               # Generate a new Service
$ feathers generate hook                  # Generate a new Hook
$ feathers generate model                 # Generate a new Model
$ feathers help                           # Show all commands

Help

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

License