-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #68 from duncannevin/master
Updated readme.
- Loading branch information
Showing
3 changed files
with
63 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,62 @@ | ||
# 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 | ||
|
||
* * * |