mirror of
https://github.com/wassname/talk.git
synced 2026-07-17 11:33:39 +08:00
Update README
This commit is contained in:
@@ -1,6 +1,12 @@
|
||||
# Talk [](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**
|
||||
|
||||
Reference in New Issue
Block a user