Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme. #68

Merged
merged 7 commits into from Jan 20, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added to Readme
  • Loading branch information
duncannevin committed Jan 20, 2017
commit 172af638c49aa714fa4863088b0cf7f0792bd230
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

* * *