Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zeusdeux committed Aug 27, 2019
1 parent 9f88c33 commit 4f09c2e
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions Readme.md
Expand Up @@ -6,10 +6,22 @@ functions and the wonderful [FaunaDB](https://fauna.com).

## Motivation

To teach myself how JWTs work and also implement user registration done correctly<sup>\*</sup>.
I wrote this to teach myself how JWTs work and also implement user
registration done correctly<sup>\*</sup>.

> <sup>\*</sup>Waiting on https://github.com/zeit/node-file-trace/pull/53 to switch to argon2
## Implemented functionality

> WIP
- sign up as new user (or re-sign up as a deleted user which is transparent to the user)
- login and get JWT with 1 hour expiry (multiple logged in sessions supported)
- access protected route with only with a valid token
- logout (kills _all_ logged in sessions and invalidates all tokens for the user)
- delete user

## Code structure

- `api/*` holds the lambdas that map to each supported route
- `models/*` holds the models for the entities in the system (User & Token) and some helpers
- `errors/*` holds the custom error tooling for the codebase
- `utils/*` hold code structure and type level utilties

1 comment on commit 4f09c2e

@vercel
Copy link

@vercel vercel bot commented on 4f09c2e Aug 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deployment failed with the following error:

Environment variables must must not be greater than 4kb when JSON-stringified (got 4.88KB)

Please sign in to comment.