Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 1.82 KB

README.md

File metadata and controls

56 lines (35 loc) · 1.82 KB
Raw

cameoServer

The backend for the cameoNet messenger. It is developed in Scala using the Play Framework.

The web client can be optionally installed to /public. See the client repository for installation instructions.

API Documentation

The documentation of the API can be found here

Dependencies

  • Java 7

Run locally for testing and development

  • run './sbt run' in the project folder

  • a mongoDB instance with some test data will be started in memory

  • all dependencies will be downloaded and the instance will listen on port 9000

  • the tests can be run with "./sbt test"

Deploy on server

  • A mongoDB v2.6 instance is required
  • Adjust configuration in "conf/application_prod.conf"
  • run './sbt "start -Dconfig.file=conf/application_prod.conf"' in the project folder
  • all dependencies will be downloaded and the instance will listen on port 9000
  • press "Ctrl-D" to keep the server running in the background

Licence

cameoNet source files are made available under the terms of the GNU Affero General Public License (AGPL).

Third Party Libraries and Frameworks