scavengerhunt-api/README.md

Scavenger Hunt API

REST API to support a community scavenger hunt app.

Environment variables

• DB_PASSWORD Password for the database
• DB_URL JDBC URL for the database
• DB_USER Username for the database
• JWT_SECRET Secret pass for the JWT

TODO:

User Endpoints

• list teams for hunt GET /hunt/{id}/team
• create new hunt team POST /hunt/{id}/team
• join hunt team POST /hunt/{id}/team/{id}
• list items for hunt GET /hunt/{id}/item
• get hunt item info GET /hunt/{id}/item/{id}
• get hunt team item info GET /hunt/{id}/team/{id}/item/{id}
• get photos for hunt item GET /hunt/{id}/team/{id}/item/{id}/photo
• upload photo for hunt item POST /hunt/{id}/team/{id}/item/{id}/photo
• delete photo for hunt item DELETE /hunt/{id}/team/{id}/item/{id}/photo
• list hunt teams with scores for hunt GET /lead/hunt/{id}/team
• list hunters with scores for hunt GET /lead/hunt/{id}/hunter

Admin Endpoints

• approve photo for hunt item POST /admin/hunt/{id}/team/{id}