Skip to content

Latest commit

 

History

History
112 lines (67 loc) · 4.05 KB

RUNNING_FIRST_TIME.md

File metadata and controls

112 lines (67 loc) · 4.05 KB
Raw

Running WebApp for the First Time

Go back to Readme Home

Please make sure you have read:

Note that for the following steps, you must have activated the WebAppEnv Node virtual environment that you set up when preparing your environment. As a reminder, to activate the environment, you can run:

$ cd /Users/<YOUR NAME HERE>/NodeEnvironments/WebAppEnv/
$ . bin/activate

Local config.js file

Every developer needs to maintain their own WebApp/src/js/config.js file, which can be copied from WebApp/src/js/config-template.js. The default configuration, copied from config-template.js, should work as-is for new developers.

Copy WebApp/src/js/config-template.js into WebApp/src/js/config.js:

(WebAppEnv) $ cd /Users/<YOUR NAME HERE>/MyProjects/WebApp
(WebAppEnv) $ cp src/js/config-template.js src/js/config.js
(WebAppEnv) $ cp tests/browserstack/browserstack.config-template.js tests/browserstack/browserstack.config.js

Mac users will need to install fsevents ("Native access to OS X FSEvents in Node.js"):

(WebAppEnv) $ cd /Users/<YOUR NAME HERE>/MyProjects/WebApp
(WebAppEnv) $ npm install fsevents

Install and start web application

(WebAppEnv) $ cd /Users/<YOUR NAME HERE>/MyProjects/WebApp
(WebAppEnv) $ npm install      // try sudo if it does not work
(WebAppEnv) $ npm start

You should be able to visit WebApp here:

http://localhost:3000

(If you would like to run the WebApp on a different port follow these instructions)

Start the WebApp in HTTPS

You will need to install OpenSSL in order to make an ssl (https) connection to the WebApp on your local PC/Mac. An https connection will be required for oauth logins via Twitter, Facebook, or Apple connect. It is also required for donation with Stripe.

To install OpenSSL for Mac OS X, type in your terminal:

  1. brew install openssl

  2. After installation, check the version: openssl version

  3. If it's not showing the most recent version, then you need to symlink to the updated openssl version like so:

    ln -s /usr/local/Cellar/openssl/1.0.2h_1/bin/openssl /usr/local/bin/openssl

Now create a self signed certificate, starting from the WebApp folder.

 openssl genrsa -des3 -passout pass:x -out server.pass.key 2048
 openssl rsa -passin pass:x -in server.pass.key -out server.key
 rm server.pass.key
 openssl req -new -key server.key -out server.csr

At this point you will be asked for certificate information, like this:

 Country Name (2 letter code) []:US
 State or Province Name (full name) []:California
 Locality Name (eg, city) []:Oakland
 Organization Name (eg, company) []:We Vote
 Organizational Unit Name (eg, section) []:
 Common Name (eg, fully qualified host name) []:localhost
 Email Address []:

 Please enter the following 'extra' attributes
 to be sent with your certificate request
 A challenge password []:

Finally run this:

 openssl x509 -req -sha256 -days 365 -in server.csr -signkey server.key -out server.crt
 mv server.key ./src/cert/
 mv server.crt ./src/cert/

Enter this into your Chrome address bar:

 chrome://flags/#allow-insecure-localhost

And then enable that setting. You will have to restart your browser.

Then you should be able to start the WebApp using SSL

(WebAppEnv) $ npm run start-https

You should be able to visit WebApp via HTTPS here:

https://localhost:3000

Using We Vote API server Locally: OPTIONAL

The default configuration connections to our live API server at: https://api.wevoteusa.org, so this step is optional.

If you would like to install the We Vote API server locally, start by reading the instructions to install WeVoteServer.

Next: Working with WebApp Day-to-Day

Go back to Readme Home