Added support for building releases, instructions for doing so, and updated README accordingly.

This commit is contained in:
Douglas Muth 2022-02-06 17:26:40 -05:00
parent 25012823ed
commit c99bf78f11
4 changed files with 436 additions and 382 deletions

4
.gitignore vendored
View file

@ -4,3 +4,7 @@
node_modules/
dist/bundle.js
diceware.zip

View file

@ -19,11 +19,12 @@ For more information on Diceware:
# Can I run this on my own computer without using your website?
Yes. Feel free to clone this repo with `git clone https://github.com/dmuth/diceware.git` and run it
from a local directory on your computer.
Yes! Go to https://github.com/dmuth/diceware/releases and download the latest `diceware.zip` file.
When you unzip that file, the contents will be written to a directory called `diceware/`. You
can then point a webserver on your machine to `diceware/index.html` in order to use Diceware.
You can also set up a webserver on Mac/Linux boxes by running `python3 -m http.server 8000`.
You will then able to access DiceWare at http://localhost:8000/.
Sadly, you cannot open `diceware/index.html` directly, as the CORS policy in Chrome prevents that.
If you know of a way to fix that, please [open an issue](https://github.com/dmuth/diceware/issues). :-)
# Will this work on an iPhone?
@ -77,6 +78,12 @@ A local webserver can be set up by running `npm install http-server -g` to insta
- `./go-sync-to-s3.sh` - Do this if you're me, to upload to S3. If you're not me, you'll need to do something else, or possibly nothing at all.
### Releasing a New Build
- `npm run release-build` to create the ZIP file `diceware.zip` with all assets in it, including `bundle.js` and the contents of `node_modules/`.
- `gh release create v1.0.0` to upload a release to https://github.com/dmuth/diceware/releases. Change the tag for the version number accordingly.
# Who built this? / Contact
My name is Douglas Muth, and I am a software engineer in Philadelphia, PA.

796
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -10,7 +10,8 @@
"test": "mocha ./tests/test.js",
"clean": "rm -rfv dist/*bundle.js* node_modules package-lock.json",
"build": "npm install; webpack --mode production",
"dev-build": "npm install; webpack --watch --mode development"
"dev-build": "npm install; webpack --watch --mode development",
"release-build": "rm -fv diceware.zip; pushd .. > /dev/null; zip -r diceware.zip diceware/; popd > /dev/null; mv ../diceware.zip ."
},
"repository": {
"type": "git",