# editor-api

> Editor API in Feathers

## About

This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.

## Getting Started

Getting up and running is as easy as 1, 2, 3.

1. Make sure you have [NodeJS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) installed.
2. Install your dependencies

    ```
    cd path/to/editor-api
    yarn
    ```

3. Start your app

    ```
    yarn dev
    ```

## Testing

Simply run `yarn test` and all your tests in the `test/` directory will be run, with code coverage.

## 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 help                           # Show all commands
```

## Help

For more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).