Skip to content

Commit

Permalink
organize into directories
Browse files Browse the repository at this point in the history
  • Loading branch information
hurrymaplelad committed Nov 1, 2022
1 parent 9bac93c commit b2139f3
Show file tree
Hide file tree
Showing 11 changed files with 202 additions and 184 deletions.
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
.idea
node_modules
.staticrypt.json
/cli/README.md
/cli/LICENSE
/cli/password_template.html
/www/password_template.html
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,19 +133,26 @@ The salt isn't secret, so you don't need to worry about hiding the config file.

## Contributing

### Source Directories

- `cli/` - The command-line interface published to NPM.
- `example/` - This file is encrypted as part of the build. The encrypted file is committed both to make this library easy to explore and as a review-time sanity check.
- `lib/` - Files shared across www and cli.
- `scripts/` - Build, test, deploy, CI, etc. See `npm run-script`.
- `www/` - The source for the in-browser encryption site hosted at https://robinmoisson.github.io/staticrypt.

### Build
Built assets are committed to main. Run build before submitting a PR or publishing to npm.

```
# From staticrypt/
$ cd cli
$ npm install
$ npm run build
```

### Test
Testing is currently manual to keep dependencies low.
[Build](#build), then open `example_encypted.html`.
[Build](#build), then open `example/example_encypted.html`.

## 🙏 Contribution

Expand Down
Loading

0 comments on commit b2139f3

Please sign in to comment.