A hub for GOT fans to share their ideas and theories.
Softwares needed for this project
node
npm
Run the followings commands to get the project running
$ git clone
$ cd <dir name>
$ npm install
$ npm start
Registers a user to our system
-
URL
/users/signup
-
Method:
POST
-
URL Params
None
-
Data Params
{ "username":string, "firstname":string, "lastname":string, "email":email, "password":"string" }
-
Success Response:
- Code: 200
Content:{ message: "Successful Signup." }
- Code: 200
-
Error Response:
- Code: 400
Content:{ error : error message , status: 400 }
- Code: 400
Registers a user to our system
-
URL
/users/login
-
Method:
POST
-
URL Params
None
-
Data Params
{ "username":string, "password":string }
-
Success Response:
- Code: 200
Content:{ message: "Successful Login.", "token":token }
- Code: 200
-
Error Response:
- Code: 400
Content:{ error : error message, status: 400 }
- Code: 400
See info and posts of a user
-
URL
/users/:username
-
Method:
GET
-
URL Params
username
-
Data Params
None
-
Success Response:
- Code: 200
Content:{ "username":string, "firstname":string, "lastname":string, "email":email, "posts":[ posts ] }
- Code: 200
-
Error Response:
-
Code: 400
Content:{ error : error message, status: 400 }
-
Code: 401
Content:unauthorized
-
Allow user to post.
-
URL
/posts/
-
Method:
POST
-
URL Params
None
-
Data Params
{ "content":string }
-
Success Response:
- Code: 200
Content:{ message: "Your post has been posted." }
- Code: 200
-
Error Response:
-
Code: 400
Content:{ error : error message, status: 400 }
-
Code: 401
Content:unauthorized
-
Allow user to view last 10 posts posted by all users.
-
URL
/posts/recent
-
Method:
GET
-
URL Params
None
-
Data Params
None
-
Success Response:
- Code: 200
Content:[{ id: id, creator: string, content: string }]
- Code: 200
-
Error Response:
-
Code: 400
Content:{ error : error message, status: 400 }
-
Code: 401
Content:unauthorized
-
Allow user to view posts that contain a specific hashtag
-
URL
/hashtag/:hashtag
-
Method:
GET
-
URL Params
hashtag
-
Data Params
None
-
Success Response:
- Code: 200
Content:[{ id: id, creator: string, content: string }]
- Code: 200
-
Error Response:
-
Code: 400
Content:{ error : error message, status: 400 }
-
Code: 401
Content:unauthorized
-