cashshuffle-web

This is the repository for cashshuffle.com.

CashShuffle is a CoinShuffle implementation for Bitcoin Cash wallets.

http://crypsys.mmci.uni-saarland.de/projects/CoinShuffle/

Building & Deploying

There are two tools used to build the final docker image:

1. Grunt
2. Rebuild.sh

These tools are biased towards development environments, and the default settings of all scripts assume you are actively developing. When pushing to production you will need to use flags as described below.

Grunt

The Grunt command runs the following tasks:

1. Concatenate and minify all CSS & JS files
2. Builds the HTML files from our templates
3. Copies all files to a folder called .build

Rebuild.sh

This simple bash script will run the following commands:

1. Stop and remove this Docker image if it exists.
2. Build and run this Docker image exposing port 5005.

How to Build for Development

1. Grunt: Run the command grunt
2. Rebuild.sh: Run the command ./rebuild.sh

The grunt script will process and output the files, and will keep watching the src folder for changes.

The rebuild script only needs to be run once. It binds the /usr/share/nginx/html/ folder to your working .build folder so you can see the results of any changes immediately.

Here are the commands that are executed by running rebuild.sh:

docker stop cashshuffle-web-dev
docker rm cashshuffle-web-dev
docker build . -t cashshuffle-web-dev
docker run -it -p 5005:8090 --name cashshuffle-web-dev --mount type=bind,source=/path/to/cashshuffle-web/.build,target=/usr/share/nginx/html/ cashshuffle-web-dev

How to Build for Production

1. Grunt: Run the command grunt live
2. Rebuild.sh: Run the command ./rebuild.sh -p

The grunt script will run the same as in development, but with the following differences:

1. It will erase the .build folder before running any other tasks
2. It will not run the watch task

The rebuild script with the -p flag does not mount your local .build folder. It will run the following commands:

docker stop cashshuffle-web
docker rm cashshuffle-web
docker build . -t cashshuffle-web
docker run -d -p 5005:8090 --name cashshuffle-web zquestz/cashshuffle-web

Testing Production Setup Locally

At some point during development, you may want to work locally but with the same settings you would expect on the production server. For example, you may wish to verify that the minified CSS & JS files are working correctly. In that case, run the following grunt command:

grunt -env=production

This will instruct grunt to use the same settings that it uses for a production environment, but will still run the watch task at the end.

License

cashshuffle.com is released under the terms of the MIT license. See LICENSE for more information or see https://opensource.org/licenses/MIT.