Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Organize source files into more directories #137

Merged
merged 2 commits into from
Nov 5, 2022
Merged

Organize source files into more directories #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2139f3
organize into directories
hurrymaplelad Oct 23, 2022
729d8c2
address comments from PR#137
hurrymaplelad Nov 1, 2022
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
4 changes: 1 addition & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
.idea
.vscode/
node_modules
.staticrypt.json
/cli/README.md
/cli/LICENSE
/cli/password_template.html
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
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`.
- `index.html` - The root of the in-browser encryption site hosted at https://robinmoisson.github.io/staticrypt. Kept in the root of the repo for easy deploys to GitHub Pages.

### 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