From c7cf2785fd841a1919dbb5ec0c5171b4047f3ea5 Mon Sep 17 00:00:00 2001 From: Kim Gardner Date: Mon, 7 Nov 2016 21:36:52 -0500 Subject: [PATCH] Update README --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d295ef326..f3a2d55fc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # Talk [![CircleCI](https://circleci.com/gh/coralproject/talk.svg?style=svg)](https://circleci.com/gh/coralproject/talk) A commenting platform from The Coral Project. [https://coralproject.net](https://coralproject.net) +## Contributing to Talk + +### Local Dependencies +Node +Mongo + ### Getting Started `npm install` Run it once to install the dependencies. @@ -8,16 +14,21 @@ Run it once to install the dependencies. `npm start` Runs Talk. +### Running with Docker +Make sure you have Docker running first and then run `docker-compose up -d` + ### Testing `npm test` ### Lint `npm run lint` +### Helpful URLs +Bare comment stream: http://localhost:5000/client/coral-embed-stream/ +Comment stream embedded on sample article: http://localhost:5000/client/coral-embed-stream/samplearticle.html + ### Docs `swagger.yaml` -### Mantainers - ### License **Apache-2.0**