Skip to content

Commit

Permalink
Overhaul README adding logo
Browse files Browse the repository at this point in the history
The README for this repo should only need to
have docs for setting up the web application with
a link to the WeVoteServer at bottom
  • Loading branch information
pertrai1 committed Feb 16, 2016
1 parent 56bc3b1 commit a188a4e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 50 deletions.
68 changes: 18 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# README for We Vote WebApp
#We Vote USA Web/Mobile Web Application

![WeVoteUS](wevotelogo.png)

[![Build Status](https://travis-ci.org/wevote/WebApp.svg?branch=develop)](https://travis-ci.org/wevote/WebApp) |
[![Coverage Status](https://coveralls.io/repos/github/wevote/WebApp/badge.svg?branch=master)](https://coveralls.io/github/wevote/WebApp?branch=develop)

This WebApp repository contains a Node/React/Flux Javascript application. Using data from
Google Civic API, Vote Smart, MapLight, TheUnitedStates.io and the Voting Information Project, we give voters a
Expand All @@ -10,68 +11,35 @@ social way to interact with ballot data.
You can see our current wireframe mockup for a San Francisco ballot here:
http://start.wevoteusa.org/

## Install WeVoteServer First
In order to get the data the WebApp needs, please
[install WeVoteServer](https://github.com/wevote/WeVoteServer/blob/master/README_API_INSTALL.md)


## Install nodeenv ("Node Env")

Install nodeenv globally. For instructions installing it locally, see: https://github.com/ekalinin/nodeenv

$ cd ~
$ sudo pip install nodeenv

Create a place for your WebApp virtual environment to live on your hard drive. We recommend installing it
away from the WebApp source code:

$ mkdir /Users/<YOUR NAME HERE>/NodeEnvironments/
$ cd /Users/<YOUR NAME HERE>/NodeEnvironments/

Now create a new virtual environment in that 'NodeEnvironments' folder. This can take many minutes.

$ nodeenv WebAppEnv

Now activate this new virtual environment:
## Getting started

$ cd /Users/<YOUR NAME HERE>/NodeEnvironments/WebAppEnv/
$ . bin/activate
1. Fork the repository to your GitHub repo.
2. Clone your repository to your local machine
3. **Always** start from the develop branch
4. When working on features or hotfixes, created a new branch and push those for pull requests - [See contributing for more](CONTRIBUTING.md)
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.

Confirm the versions of your main packages are >= to these versions:
Before starting local development, confirm the versions of your main packages are >= to these versions:

(WebAppEnv) $ node -v
$ node -v
v5.3.0

(WebAppEnv) $ npm -v
$ npm -v
3.3.12


## Clone https://github.com/wevote/WebApp

Create a place to put all of the code from Github:

$ mkdir /Users/<YOUR NAME HERE>/MyProjects/

Retrieve “WebApp” into that folder, so your code ends up here:

/Users/<YOUR NAME HERE>/MyProjects/WebApp


## Install and start web application

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

You should be able to visit WebApp here:

http://localhost:3000


## After Installation: Working with WebApp Day-to-Day

[Read about working with WebApp on a daily basis](README_WORKING_WITH_WEB_APP.md)
## Using WeVote Backend Locally
First, start by reading the instructions[install WeVoteServer](https://github.com/wevote/WeVoteServer/blob/master/README_API_INSTALL.md)

## SemVer

Expand Down
Binary file added wevotelogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a188a4e

Please sign in to comment.