Skip to content

Latest commit

 

History

History
31 lines (28 loc) · 1.13 KB

README.md

File metadata and controls

31 lines (28 loc) · 1.13 KB

OurBoARd

Post your photos onto an AR bulletin board for everyone to see! 🖼️
Won Honourable mention for the Community & Connection Track AND Best Beginner Hack at NWHacks 2024. 🏆

devpost: https://devpost.com/software/ourboard
live site: https://ourboard-nw.netlify.app/ (only responsive for mobile)

API Specification

Uses simple specification from JSend.

  • POST /addImage:
    • image : base64 encoded image
    • Response:
      • status : "success" or "fail" or "error"
      • if status was "error", message : user-readable string
      • data : null
  • GET /getBoard:
    • Response:
      • status : "success" or "fail" or "error"
      • if status was "error", "message" : user-readable string
      • data :
        • board : base64 encoded board image
  • POST /addNote:
    • text : text to put in note
    • Response:
      • status : "success" or "fail" or "error"
      • if status was "error", message : user-readable string
      • if status was "fail", data: text: : reason text is bad
      • data : null