Skip to content

Commit

Permalink
Zee: Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
Zee committed Feb 15, 2016
1 parent 9371e92 commit 198c1a4
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# family-friendly-api
----
This is the API for family-friendly. The app and website which are seperate projects will be able to connect to this endpoint hopefully with an authenticated token and send/ receive data.

## Install
* clone repository
* npm install to install node modules
* npm test to run tests
* npm run start to start the app
* API lives on http://localhost:3000
----
## TO-DO
* Implement authenticated token for sending and getting a request from the server.
* Implement more tests around the movie api endpoints.
* ```movie/:movieid/credits```
* ```movie/:movieid/images```
* ```movie/:movieid/video```
* ```movie/:movieid/keywords```
* ```movie/:movieid/trailer```
* ```movie/:movieid/similarmovies```
* ```movie/latestmovies```
* add to collection? ```account/collection/:id ``` - this would need user data registering... maybe something to look at.

0 comments on commit 198c1a4

Please sign in to comment.