A real-time threaded forum micro-service API in Node.js.
Yeti Threads was written to explore and document a simple and solid approach for micro-service APIs in Node.js. It also happens to be a practical solution to a common need.
- Install Postgres
- git clone https://github.com/andyet/yeti-threads.git
- cd yeti-threads
- cp config/example.json config/local.json
- edit config/local.json
- set jwtKey. Try something like
console.log(require('crypto').randomBytes(48).toString('base64'));to generate a value.
- cp config/local.json config/test.json
- npm i
- npm test
- npm start
As of now, there are no clients yet. Have at it!
Login and Auth Tokens
The API requires the use of JSON Web Tokens for authentication.
Auth0 provides a free service which can provide a login page, user management, tokens, and proper redirects back your client API. Or you can use your own, of course!
The API is a fairly straight forward REST API for forums, threads, posts, access, and activity logs. It also includes a websocket API for live hints for new/updated resources.
Please read more at API.md
This project is MIT Licensed. Feel free to use it as you see fit. We also accept pull requests!
© 2015 &yet LLC.