Ind.ie is now Small Technology Foundation.
README.md 1.89 KB
Newer Older
wim-vantomme's avatar
wim-vantomme committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 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
# publickey-auth-feathers

> Spike 5

## 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 [npm](https://www.npmjs.com/) installed.
2. Install your dependencies

    ```
    cd path/to/publickey-auth-feathers; npm install
    ```

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).

Frauke's avatar
Frauke committed
47 48 49 50 51 52 53 54
## Notes
On the **index** page you have to fill in a password. When you submit the form, the keys will be generated and saved on the server and private key will be saved in IndexedDB. You then will be redirected to the sign in page.
On this page you can also find a 'get private data' button. When you are logged in and you click this button, you will receive private data in the console.

On the **sign in** page you have to fill in the same password as on the index page. The JWT will be created and saved in a cookie. You will be redirected to the signed in page.

On the **signed in** page you have the log out button. When clicked the cookie and indexedDB will be cleared.

wim-vantomme's avatar
wim-vantomme committed
55 56 57 58 59 60 61 62 63 64 65
## Changelog

__0.1.0__

- Initial release

## License

Copyright (c) 2016

Licensed under the [MIT license](LICENSE).