Skip to content

Commit

Permalink
Added to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
duncannevin committed Jan 20, 2017
1 parent 48173e4 commit 172af63
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
4 changes: 4 additions & 0 deletions duncan.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
### Dependancies

1. npm install
2. golang.org/x/crypto/bcrypt
3. github.com/gorilla/mux
4. gopkg.in/mgo.v2
5. gopkg.in/mgo.v2/bson

* * *

Expand Down
58 changes: 58 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,61 @@
# Tesis #
## A Collaborative Editor from the future! ##

* * *

### Getting the app started ###
* This is a Golang app so be sure to clone this repo into your Gopath
* Typical gopath: $GOPATH/src/github.com/~github username~/~repo~
* For help getting started with Golang checkout https://golang.org/doc/install
* Directions are in correct order

* * *

### Global install requirements ###

* npm install karma-cli -g
* npm install jasmine -g
* npm install webpack -g

* * *

### Application dependancies ###

* Javascript
* npm install

* Golang
* go get golang.org/x/crypto/bcrypt
* go get github.com/gorilla/mux
* go get github.com/gorilla/websocket
* go get gopkg.in/mgo.v2/bson
* go get github.com/dchest/uniuri

* * *

### Build Go files ###

* From root
* go build certMaker.go (builds a self signed cert for https)

* From inside tesis/editor
* go build .

* * *

### Module Bundler ###

* webpack -w

* * *

### Servers ###

* Node server - used for running OT with shareDB
* npm start

* Go server - used for webRTC, API, and editor stats
* from root
* go run editor/*.go

* * *

0 comments on commit 172af63

Please sign in to comment.