This is the repo for the Accenture Hackathon about the Autism Awareness platform. GalacticEd, our prototype, was awarded 1st place out of 37 teams. A presentation for the prototype we built in a day is viewable here.
A basic view of the currently supported endpoints.
- GET
/api/test
- GET
/api/test/db
- POST
/api/test/db
- POST
/api/auth/login
- Parameters:
email
,password
- Returns: JSON containing
user_id
,token
,children
(See here for details on thechildren
object)
- Parameters:
- POST
/api/auth/register
- Parameters:
username
,email
,password
- Returns: JSON containing
user_id
,token
,children
(See here for details on thechildren
object)
- Parameters:
- POST
/api/auth/register/child
- Parameters:
name
,avatar
,birthday
,age
,learning_style
,favourite_object
- Parameters:
- DELETE
/api/auth/remove
- an unprotected route that wipes a user with the given email. Testing purposes only- Parameters:
email
- Parameters:
- GET
/api/auth/google/login
- GET
/api/auth/google/login/callback
See here for example JSON responses returned by the following 3 endpoints
- GET
/api/courses/lessons
- GET
/api/courses/all
- GET
/api/courses/full
- GET
/api/profile/
- Parameters:
user_id
,token
- Returns JSON containing the user's profile data (See here for details)
- Parameters:
- GET
/api/profile/stats
- Parameters:
user_id
,token
- Returns: JSON (See here for details)
- Parameters:
- POST
/api/profile/stats
- saves the child's performance stats- Parameters:
user_id
,child_id
,course_id
(eg. "shapes"),lesson_id
(eg. ""),time_on_completion
(int timestamp in seconds),num_incorrect
,time_taken
(float in seconds)- Note: the
child_id
is obtained by accessing the endpointapi/auth/login
- Note: the
- Parameters:
- DELETE
/api/profile/stats
- clears the child's performance data- Parameters:
user_id
,child_id
- Parameters:
- GET
/api/recommend/next_lesson
[TODO]- Parameters:
user_id
,child_id
,course_id
- Returns:
lesson_id
of the recommended lesson for the given course
- Parameters:
The JSON formats here specify the schema for the MongoDB documents AND what the data structures exchanged between frontend and backend look like.
https://gist.github.com/Tymotex/b25b5d6ad9b9a9e8a5c9b0253581abd0