Files
talk/README.md
T
2016-11-08 14:25:53 -05:00

36 lines
826 B
Markdown

# 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.
`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
Moderator view: http://localhost:5000/admin/
### Docs
`swagger.yaml`
### License
**Apache-2.0**