diff --git a/duncan.md b/duncan.md index 58ba314..c2a4047 100644 --- a/duncan.md +++ b/duncan.md @@ -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 * * * diff --git a/readme.md b/readme.md index 2e2ced5..174de37 100644 --- a/readme.md +++ b/readme.md @@ -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 + +* * *