wassname/talk
1
0
Fork 0
mirror of https://github.com/wassname/talk.git synced 2026-07-01 17:46:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #143 from coralproject/format-readme

Browse Source 
Fix formatting
This commit is contained in:
Kim Gardner
2016-12-08 13:38:03 -10:00
committed by GitHub
parent cfb1b75b39 0bbefa071e
commit 82e3d73d2d
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -11
View File
@@ -10,6 +10,7 @@ You can view product ideas and our longer term roadmap here: https://trello.com/
### Local Dependencies
Node
Mongo
### Getting Started
@@ -26,17 +27,17 @@ inside the environment in order to run, those variables are listed here:
- `TALK_SESSION_SECRET` (*required*) - a random string which will be used to
secure cookies.
`TALK_FACEBOOK_APP_ID` (*required*) - the Facebook app id for your Facebook
- `TALK_FACEBOOK_APP_ID` (*required*) - the Facebook app id for your Facebook
Login enabled app.
`TALK_FACEBOOK_APP_SECRET` (*required*) - the Facebook app secret for your
- `TALK_FACEBOOK_APP_SECRET` (*required*) - the Facebook app secret for your
Facebook Login enabled app.
`TALK_ROOT_URL` (*required*) - root url of the installed application externally
- `TALK_ROOT_URL` (*required*) - root url of the installed application externally
available in the format: `<scheme>://<host>` without the path.
`TALK_SMTP_PROVIDER` (*required*) - SMTP provider name.
`TALK_SMTP_USERNAME` (*required*) - username of the SMTP provider you are using.
`TALK_SMTP_PASSWORD` (*required*) - password for the SMTP provider you are using.
`TALK_SMTP_HOST` (*required*) - SMTP host url with format `smtp.domain.com`.
`TALK_SMTP_PORT` (*required*) - SMTP port.
- `TALK_SMTP_PROVIDER` (*required*) - SMTP provider name.
- `TALK_SMTP_USERNAME` (*required*) - username of the SMTP provider you are using.
- `TALK_SMTP_PASSWORD` (*required*) - password for the SMTP provider you are using.
- `TALK_SMTP_HOST` (*required*) - SMTP host url with format `smtp.domain.com`.
- `TALK_SMTP_PORT` (*required*) - SMTP port.
### Running with Docker
Make sure you have Docker running first and then run `docker-compose up -d`
@@ -48,9 +49,11 @@ 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/
Comment stream embedded on sample article: http://localhost:5000/client/coral-embed-stream/samplearticle.html
Moderator view: http://localhost:5000/admin/
Comment stream: http://localhost:3000/
Comment stream embedded on sample article: http://localhost:3000/assets/samplearticle.html
Moderator view: http://localhost:3000/admin
### Docs
`swagger.yaml`