Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 4 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,6 @@
# keyroll
# KeyRoll

`keyroll` is a secure key-value storage toolkit.
## Project Structure

## Usage

### install as global dependency

`npm install -g keyroll`

### start server anywhere

```sh
# serve ~/.keyroll at 9988
keyroll

# serve ~/.keyroll at 8080
keyroll --port=8080

# fork server
keyroll fork

# stop server
keyroll stop

# show help
keyroll help
```

### access homepage

`http://localhost:YOUR-PORT`
`model` directory contains a low-level secure key-value storage library.
`views` directory contains several frontend apps.
25 changes: 0 additions & 25 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,25 +0,0 @@
# Keyroll Roadmap

## Milestone 0
1. single local storage for single user (done)
2. data model (done)
3. project boilerplate from firecell (done)

## Milestone 1
1. secure filter for data request
2. password

## Milestone 2
1. extensible data schema

## Milestone 3
1. custom local storage devices
2. usb devices

## Milestone 4
1. backup and recovery at external storage or cloud like google or onedrive

## Milestone 5
1. biometric - human face
2. biometric - voice code
3. biometric - finger print
1 change: 0 additions & 1 deletion lib/static/index.js

This file was deleted.

19 changes: 19 additions & 0 deletions model/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "@voram/keyroll",
"version": "0.1.0",
"description": "A low-level secure key-value storage.",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+ssh://git@github.com/voram/keyroll.git"
},
"author": "Sartrey Lee",
"license": "MIT",
"bugs": {
"url": "https://github.com/voram/keyroll/issues"
},
"homepage": "https://github.com/voram/keyroll#readme"
}
File renamed without changes.
File renamed without changes.
32 changes: 32 additions & 0 deletions views/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# keyroll

`keyroll` is a secure key-value storage toolkit.

## Usage

### install as global dependency

`npm install -g keyroll`

### start server anywhere

```sh
# serve ~/.keyroll at 9988
keyroll

# serve ~/.keyroll at 8080
keyroll --port=8080

# fork server
keyroll fork

# stop server
keyroll stop

# show help
keyroll help
```

### access homepage

`http://localhost:YOUR-PORT`
25 changes: 25 additions & 0 deletions views/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Keyroll Roadmap

## Milestone 0
1. single local storage for single user (done)
2. data model (done)
3. project boilerplate from firecell (done)

## Milestone 1
1. secure filter for data request
2. password

## Milestone 2
1. extensible data schema

## Milestone 3
1. custom local storage devices
2. usb devices

## Milestone 4
1. backup and recovery at external storage or cloud like google or onedrive

## Milestone 5
1. biometric - human face
2. biometric - voice code
3. biometric - finger print
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions lib/static/index.css → views/lib/static/index.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions views/lib/static/index.css.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading