1
- # README for We Vote WebApp
1
+ #We Vote USA Web/Mobile Web Application
2
+
3
+ ![ WeVoteUS] ( wevotelogo.png )
2
4
3
5
[ ![ Build Status] ( https://travis-ci.org/wevote/WebApp.svg?branch=develop )] ( https://travis-ci.org/wevote/WebApp ) |
4
- [ ![ Coverage Status] ( https://coveralls.io/repos/github/wevote/WebApp/badge.svg?branch=master )] ( https://coveralls.io/github/wevote/WebApp?branch=develop )
5
6
6
7
This WebApp repository contains a Node/React/Flux Javascript application. Using data from
7
8
Google Civic API, Vote Smart, MapLight, TheUnitedStates.io and the Voting Information Project, we give voters a
@@ -10,68 +11,35 @@ social way to interact with ballot data.
10
11
You can see our current wireframe mockup for a San Francisco ballot here:
11
12
http://start.wevoteusa.org/
12
13
13
- ## Install WeVoteServer First
14
- In order to get the data the WebApp needs, please
15
- [ install WeVoteServer] ( https://github.com/wevote/WeVoteServer/blob/master/README_API_INSTALL.md )
16
-
17
-
18
- ## Install nodeenv ("Node Env")
19
-
20
- Install nodeenv globally. For instructions installing it locally, see: https://github.com/ekalinin/nodeenv
21
-
22
- $ cd ~
23
- $ sudo pip install nodeenv
24
-
25
- Create a place for your WebApp virtual environment to live on your hard drive. We recommend installing it
26
- away from the WebApp source code:
27
-
28
- $ mkdir /Users/<YOUR NAME HERE>/NodeEnvironments/
29
- $ cd /Users/<YOUR NAME HERE>/NodeEnvironments/
30
-
31
- Now create a new virtual environment in that 'NodeEnvironments' folder. This can take many minutes.
32
-
33
- $ nodeenv WebAppEnv
34
-
35
- Now activate this new virtual environment:
14
+ ## Getting started
36
15
37
- $ cd /Users/<YOUR NAME HERE>/NodeEnvironments/WebAppEnv/
38
- $ . bin/activate
16
+ 1 . Fork the repository to your GitHub repo.
17
+ 2 . Clone your repository to your local machine
18
+ 3 . ** Always** start from the develop branch
19
+ 4 . When working on features or hotfixes, created a new branch and push those for pull requests - [ See contributing for more] ( CONTRIBUTING.md )
20
+ 5 . Request a pull request. If there is an issue that the pull request is tried to, include the number of the issue in your description.
39
21
40
- Confirm the versions of your main packages are >= to these versions:
22
+ Before starting local development, confirm the versions of your main packages are >= to these versions:
41
23
42
- (WebAppEnv) $ node -v
24
+ $ node -v
43
25
v5.3.0
44
26
45
- (WebAppEnv) $ npm -v
27
+ $ npm -v
46
28
3.3.12
47
29
48
-
49
- ## Clone https://github.com/wevote/WebApp
50
-
51
- Create a place to put all of the code from Github:
52
-
53
- $ mkdir /Users/<YOUR NAME HERE>/MyProjects/
54
-
55
- Retrieve “WebApp” into that folder, so your code ends up here:
56
-
57
- /Users/<YOUR NAME HERE>/MyProjects/WebApp
58
-
59
-
60
30
## Install and start web application
61
31
62
- (WebAppEnv) $ cd /Users/<YOUR NAME HERE>/MyProjects/WebApp
63
- (WebAppEnv) $ npm -g install gulp-cli // try sudo if it does not work
64
- (WebAppEnv) $ npm install
65
- (WebAppEnv) $ gulp
32
+ $ cd /Users/<YOUR NAME HERE>/MyProjects/WebApp
33
+ $ npm -g install gulp-cli // try sudo if it does not work
34
+ $ npm install
35
+ $ gulp
66
36
67
37
You should be able to visit WebApp here:
68
38
69
39
http://localhost:3000
70
40
71
-
72
- ## After Installation: Working with WebApp Day-to-Day
73
-
74
- [ Read about working with WebApp on a daily basis] ( README_WORKING_WITH_WEB_APP.md )
41
+ ## Using WeVote Backend Locally
42
+ First, start by reading the instructions[ install WeVoteServer] ( https://github.com/wevote/WeVoteServer/blob/master/README_API_INSTALL.md )
75
43
76
44
## SemVer
77
45
0 commit comments