README.md 1.32 KB
Newer Older
Frauke's avatar
Frauke committed
1
# publickey-auth-feathers-nuxt
Frauke's avatar
Frauke committed
2

Frauke's avatar
Frauke committed
3
> Publickey Authentication With Feathers, Vuex, And Nuxt
Frauke's avatar
Frauke committed
4 5 6 7

## About

This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.
Frauke's avatar
Frauke committed
8
An also [Nuxt](https://nuxtjs.org)
Frauke's avatar
Frauke committed
9 10 11 12 13 14 15 16 17

## Getting Started

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

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

    ```
Frauke's avatar
Frauke committed
18
    cd path/to/publickey-auth-feathers-nuxt; npm install
Frauke's avatar
Frauke committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
    ```

3. Start your app

    ```
    npm 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](http://docs.feathersjs.com).

## Changelog

__0.1.0__

- Initial release

## License

Copyright (c) 2016

Licensed under the [MIT license](LICENSE).