diff --git a/package.json b/package.json index a10deac..fec2c2b 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,8 @@ "vinyl-source-stream": "^1.1.0" }, "scripts": { - "start": "npm run bundle && gulp start", + "start": "npm run bundle && node index.js", + "dev": "npm run bundle && gulp start", "bundle": "gulp bundle", "test": "npm run bundle && gulp test", "test-travis": "node_modules/mocha/bin/mocha test/unit --compilers js:babel-core/register && node_modules/nightwatch/bin/nightwatch --test test/acceptance/index.js --config test/acceptance/nightwatch.json -e chrome" diff --git a/readme.md b/readme.md index 60da626..0f866e9 100644 --- a/readme.md +++ b/readme.md @@ -5,27 +5,26 @@ Simple encrypted web chat. Powered by [socket.io](http://socket.io) and the [web cryptography API](https://developer.mozilla.org/en-US/docs/Web/API/Window/crypto). ### Installation - # For es6 compatability, be sure you have the latest stable version of Node JS installed + # Get latest version of NodeJS for ES2015 support npm install -g n n stable npm install - # Bundle JS files (for deployment) - npm bundle + # Starting dev environment + npm run dev + # Running tests locally - brew install chromedriver # Installs chromedriver to /usr/local/bin + brew install chromedriver npm test - # Start a local instance of darkwire / for dev + + # Start a local instance of darkwire npm start + # Changing ports, default is 3000 + port=3000 npm start + Darkwire is now running on `http://localhost:3000` -### Deployment - -Build source - - gulp bundle - ### How it works Darkwire uses a combination of asymmetric encryption (RSA-OAEP), symmetric session keys (AES-CBC) and signing keys (HMAC) for security.