@@ -4,39 +4,40 @@ A scalable and highly flexible HTML5/JS platform to build and run in-browser app
44
55* Web site: http://socr.umich.edu
66* Issue-tracking and project management: https://socredu.atlassian.net/browse/SOCRFW
7- * ** Disclaimer : project is under active development, unit tests currently are not passing, bugs are possible**
7+ * ** Note : project is under active development, unit tests currently are not passing, bugs are possible**
88
99[ ![ Build Status] ( https://travis-ci.org/SOCR/SOCRAT.svg?branch=master )] ( https://travis-ci.org/SOCR/SOCRAT )
1010[ ![ Dependency Status] ( https://gemnasium.com/SOCR/SOCRAT.png?branch=master )] ( https://gemnasium.com/SOCR/SOCRAT )
1111
1212Installation
1313------------
14- In case you wish to create your own module or contribute to the project, follow these steps to setup your enviroment .
14+ In case you wish to create your own module or contribute to the project, follow these steps to setup your environment .
1515
16- First, install [ nodejs ] ( http://nodejs.org/ ) if you haven't. npm is the package manager for Node.js and comes bundled with it.
16+ First, install [ Node.js ] ( http://nodejs.org/ ) if you haven't yet. ` npm ` is the package manager for ` Node.js ` and comes bundled with it.
1717
18- Install Webpack,
18+ Install Webpack:
1919
20- $> npm install webpack -g
20+ $> sudo npm install webpack -g
2121
22- Clone the repository.
22+ Clone the repository:
2323
24- $> git clone https://github.com/SOCR/SOCRAT.git
24+ $> git clone https://github.com/SOCR/SOCRAT.git
25+ $> cd SOCRAT
26+
27+ If you're interested in latest changes or want to contribute to the project, switch to the ` dev ` branch:
2528
26- Now, lets install all the dependencies. Go into the root folder,
29+ $> git checkout dev
30+ $> git pull
31+
32+ Now, lets install all the dependencies:
2733
28- $> cd SOCRAT
2934 $> npm install
3035
3136This will install all the dependencies mentioned in package.json files.
3237
33- Start the server and see the application running at localhost:8080:
38+ Start the development server and see the application running at ` localhost:8080 ` :
3439
3540 $> npm run serve
36-
37- To start unit-test use. Status information will appear in the new browser window. Test runner will log into console.
38-
39- $> npm run test
4041
4142
4243Motivation
0 commit comments