From c7cf2785fd841a1919dbb5ec0c5171b4047f3ea5 Mon Sep 17 00:00:00 2001 From: Kim Gardner Date: Mon, 7 Nov 2016 21:36:52 -0500 Subject: [PATCH 1/4] 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** From e3074892ce8e1870cc7097245e58261f27c2ed97 Mon Sep 17 00:00:00 2001 From: Kim Gardner Date: Tue, 8 Nov 2016 11:56:55 -0500 Subject: [PATCH 2/4] Add moderator view URL --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f3a2d55fc..3408c9f11 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ Make sure you have Docker running first and then run `docker-compose up -d` ### 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 +Moderator view: http://localhost:5000/client/coral-admin/ ### Docs `swagger.yaml` From db66c66f3da9a84d162ce4ce9c97282273f57d77 Mon Sep 17 00:00:00 2001 From: Kim Gardner Date: Tue, 8 Nov 2016 14:23:24 -0500 Subject: [PATCH 3/4] Update admin route --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3408c9f11..103910d77 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ Make sure you have Docker running first and then run `docker-compose up -d` `npm run lint` ### Helpful URLs -Bare comment stream: http://localhost:5000/client/coral-embed-stream/ +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 -Moderator view: http://localhost:5000/client/coral-admin/ +Moderator view: http://localhost:5000/admin ### Docs `swagger.yaml` From ff42d571e6396bbb8311f1d04a69af71c8240cda Mon Sep 17 00:00:00 2001 From: Kim Gardner Date: Tue, 8 Nov 2016 14:25:53 -0500 Subject: [PATCH 4/4] Add trailing slashes to URLs --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 103910d77..f4d8b31de 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,9 @@ Make sure you have Docker running first and then run `docker-compose up -d` `npm run lint` ### Helpful URLs -Bare comment stream: http://localhost:5000/client/coral-embed-stream +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 -Moderator view: http://localhost:5000/admin +Moderator view: http://localhost:5000/admin/ ### Docs `swagger.yaml`