Add comprehensive API documentation with frontend examples

test deployment

modify and add require file

add readme

initial commit