https://server.storysquad.app - AWS Deployment
Check the wiki for a setup guide
- Useful libraries such as helmet and CORS.
- Well documented.
- Simplifies database creation, connections, queries, etc.
- Highly cross-compatible with different databases.
- Uses ESLINT to enforce lint patterns
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| POST | /email/register |
anyone | Creates new user and sends validation email |
| POST | /email/login |
anyone | Returns authorization if user exists and email validated |
| POST | /email/activate |
anyone | Validates email for a new user if given a valid query string |
| GET | /email/reset |
anyone | Request a password reset for a given email |
| POST | /email/reset |
anyone | Submit password reset information for a given email |
| POST | /resetusername |
users | Submit username reset for users logged in |
| POST | /resetpassword |
users | Submit password reset for users logged in |
| GET | /email/video |
anyone | Returns link for winners announcement YouTube video stream |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| POST | /upload/ |
user | Save new submission |
| GET | /upload/image/:id |
user | Request an image |
| GET | /upload/mytopstories |
user | Get the current users top 5 stories |
| GET | /upload/video |
user | Returns link for winners announcement YouTube video stream |
| GET | /upload/prompt |
user | Get current prompt and user-relative state |
| PUT | /upload/edit/:id |
admin | Edit a prompt |
| GET | /upload/all_prompts |
admin | Get all previous prompt data |
| POST | /upload/add |
admin | Add a new prompt |
| GET | /upload/mysubmissions |
user | Get the current users past 7 submissions for their profile |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /admin/ |
admin | Returns all active user submissions |
| GET | /admin/users |
admin | Returns all usernames |
| POST | /admin/video |
admin | Set YouTube video stream url |
| GET | /admin/flag/:id |
admin | Returns a specific flagged submission |
| POST | /admin/flag/:id |
admin | Toggles flagged status on a submission |
| GET | /admin/winners |
admin | Returns top 10 submissions for today's prompt |
| GET | /admin/image/:id |
admin | Request an image (no checks under /admin) |
| POST | /admin/remove_user_data/:email |
admin | Delete all submissions from a user |
| POST | /admin/setwinners/:prompt_id |
admin | Set winners for today's prompt |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /ranking/ |
anyone | Get the 3 winner submissions |
| POST | /ranking/ |
anyone | Submit ranking of the 3 submissions |
| GET | /ranking/votes |
anyone | Get current vote counts |
| GET | /ranking/winner |
anyone | Get the 3 winner submissions final ranking |
For information on database entities and environment variables, see the backend wiki.
See Frontend Documentation for details on the frontend of our project.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct. Please follow it in all your interactions with the project.
These contribution guidelines have been adapted from this good-Contributing.md-template.