flesh out server readme.
Project: http://git-wip-us.apache.org/repos/asf/incubator-wave/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-wave/commit/d05a19cb Tree: http://git-wip-us.apache.org/repos/asf/incubator-wave/tree/d05a19cb Diff: http://git-wip-us.apache.org/repos/asf/incubator-wave/diff/d05a19cb Branch: refs/heads/wavy Commit: d05a19cbce36239c2f91eb79e30bb1a1258a854d Parents: 824d85c Author: wisebaldone <[email protected]> Authored: Thu Apr 28 13:06:44 2016 +1000 Committer: wisebaldone <[email protected]> Committed: Thu Apr 28 13:06:44 2016 +1000 ---------------------------------------------------------------------- README.md | 2 +- server/README.md | 41 ++++++++++++++++++++++++++++++++++++----- 2 files changed, 37 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/d05a19cb/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 03604dc..68ca92a 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ todo(wisebaldone): replace with bazel command to create distributions. ## Contributing -To contirbute to Apache Wave please goto +To contirbute to Apache Wave please go to https://incubator.apache.org/wave/get-involved.html where youll be able to find information about how to participate. http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/d05a19cb/server/README.md ---------------------------------------------------------------------- diff --git a/server/README.md b/server/README.md index db89aea..e50fd67 100644 --- a/server/README.md +++ b/server/README.md @@ -1,15 +1,46 @@ # Apache Wave Server -This is the home of the Apache Wave server. The server is written in golang and .... (blurb) +This is the home of the Apache Wave server. The server is written in golang and +implements a REST like and WebSocket interface for creating, editing, deleting +XML Like documents which can have Operation Transformations applied. -## Dev Install +The server sits above a data storage layer: this layer can be implemented with +a local file storage or a no-sql database like Mongo and Cassandra (both + databases are expected to be supported in future). -list instructions on how to install pre requirements for the server +## Dev Requirements + +Required: +- Golang v1.6+ [install](https://golang.org/doc/install) + +Optional: +- Cassandra [not implemented yet] +- MongoDB [not implemented yet] ## Build Tasks -what bazel commands to run to build, run, test the server +| Task | Description | +| --- | --- | +| bazel build //server:server | Builds the server for the current platform | +| bazel test //server:test | Builds and runs all the server tests | + +Note: some tasks will require the optional dependencies, these will be noted by +the task. ## More Info -link to relevant info for finding out more (website, cwiki, other) \ No newline at end of file +todo(wisebaldone): once website created add a link here for the dev docs for the + server and for user documentation. + +## Vendoring + +Please note that this project does use vendoring and as such sources of other +projects are located in the vendor folder. Vendoring is important to provide +a stable enviroment for developers, the licenses for these projects are included +in the source distribution. + +#### Vendoring For Contributors + +Dependency management is important to providing stable projects and as such any +addition to the dependencies must be debated espically projects with large +amounts of transitive dependencies.
