Skip to content

Home

Jump to bottom
Sh Lin edited this page May 17, 2017 · 8 revisions

Welcome to the PixNyanNyan-api wiki!

Environment variables

RECAPTCHA_SITE_KEY={PUBLIC SITE KEY}
RECAPTCHA_SECRET_KEY={SECRET RECAPTCHA KEY}
SECRET_KEY_BASE={SECRET RAILS KEY}
JWT_SECRET={JWT KEY}
MAX_IMAGE_KB_SIZE=5120
MAX_POST_MESSAGE_WORDCOUNT=300
ALLOWED_ORIGIN=http://localhost:4200|http://example.com|http://example2.com

#BYPASS_RECAPTCHA=1

API

The following shows detail API usage and descriptions, however, they're subject to change in the future.

Cable(Websocket)

  • Broadcasting changes made to posts

Config

  • Retrieve backend configurations.

Thread

  • Display posts in nested structure

Post

  • Submit post
  • Delete posts
  • Search posts

Admin login

  • Login using credentials
  • Renew JWT auth token

Admin management

  • CRUD admins (require superadmin privilege)

Complaint

  • User filing complaint against unwanted/inappropriate contents.
  • Admins reviewing complaints

Blocklist

  • TBA
Clone this wiki locally