Skip to content

Commit 2ab9d3a

Browse files
committed
add build script and remove duplicate files
1 parent f231ca9 commit 2ab9d3a

File tree

9 files changed

+39
-480
lines changed

9 files changed

+39
-480
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
.idea
22
node_modules
3-
cli/.staticrypt.json
43
.staticrypt.json
4+
/cli/README.md
5+
/cli/LICENSE
6+
/cli/password_template.html

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,22 @@ If you don't want StatiCrypt to create or use the config file, you can set `--co
131131

132132
The salt isn't secret, so you don't need to worry about hiding the config file.
133133

134+
## Contributing
135+
136+
### Build
137+
Built assets are committed to main. Run build before submitting a PR or publishing to npm.
138+
139+
```
140+
# From staticrypt/
141+
$ cd cli
142+
$ npm install
143+
$ npm run build
144+
```
145+
146+
### Test
147+
Testing is currently manual to keep dependencies low.
148+
[Build](#build), then open `example_encypted.html`.
149+
134150
## 🙏 Contribution
135151

136152
Thank you: [@AaronCoplan](https://github.com/AaronCoplan) for bringing the CLI to life, [@epicfaace](https://github.com/epicfaace) & [@thomasmarr](https://github.com/thomasmarr) for sparking the caching of the passphrase in localStorage (allowing the "Remember me" checkbox)

cli/LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

cli/README.md

Lines changed: 0 additions & 146 deletions
This file was deleted.

cli/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cli/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
"version": "2.1.1",
44
"description": "Based on the [crypto-js](https://github.com/brix/crypto-js) library, StatiCrypt uses AES-256 to encrypt your input with your passphrase and put it in a HTML file with a password prompt that can decrypted in-browser (client side).",
55
"main": "index.js",
6+
"files": [
7+
"index.js",
8+
"password_template.html",
9+
"crypto-js.min.js"
10+
],
611
"bin": {
712
"staticrypt": "./index.js"
813
},
@@ -17,6 +22,7 @@
1722
"license": "MIT",
1823
"devDependencies": {},
1924
"scripts": {
25+
"build": "bash ./scripts/build.sh",
2026
"test": "echo \"Error: no test specified\" && exit 1"
2127
},
2228
"repository": {

0 commit comments

Comments
 (0)