[CS496_Week3]

Project Name: 아싸탈출 (no more outsider)

Team: HyunWoo Kang, SeungMin Lee

1. Client

• Android (java, xml)

Log in and sign up

• At first, user has to login with his account.
• If user doesn't have an account, then he can sign up with new id, password, department in university, circles or hobbies, and concerns
• User can edit his account infromation later
• After login, app supports three functionalities

TabA [List of Rooms]

• User can see all of opened rooms which is saved in DB now, and can search rooms with a keyword
• The app also supports fast search funtionality by department, and meal type
• After selecting a room, user can send a request toward the maker to join the room
• User can join the room only after the maker accepts the request
• Moreover, user can make a new room with title, type of meal (No matter/Meal/Cafe/Drinking), maximum number of users

TabB [My Room]

• User can see the list of rooms that he or she belongs to, and can search rooms with a keyword
• And if user selects a room, user can see the list of members in the same room
• Finally, user can chat with room members in real time

TabC [Messages]

• User can see the list of request messages which he or she sent, and responsed to received request
• If user receives a new request because someone wants to join in his or her room, user can accept or reject the request, and the response goes to the requester

2. Server

• Node.JS, mongoDB
• Code dependencies: express, socket.io, boody-parser, mongoose
• Server host: 13.124.143.15

Install dependencies:

$ npm install

Run server:

$ node app.js

• Our server is running on http://13.124.143.15:10001 (It may be discontinued without prior notice)

RESTful API

• GET /

  • Check Whether Server is Alive

• GET /api

  • Show what kinds of API is accessible

• GET /user

  • Show all users in DB

• GET /user/id/:id

  • Find a user whose attribute 'id' is same as request parameter's id, and return it as a response

• POST /user

  • Make a new user with request body which is consist of id, department, circle, hobby

• POST /user/:userId

  • Update user information whose attribute 'id' is same as request parameter's id

• GET /room

  • Show all rooms in DB

• GET /room/title/:title

  • Find a room which attribute 'title' is same as request parameter's title, and return it as a response

• GET /room/makerId/:makerId

  • Find a room which attribute 'makerId' is same as request parameter's makerId, and return it as a response

• GET /room/mealType/:mealType

  • Find a room which attribute 'mealType' is same as request parameter's mealType, and return it as a response

• GET /room/user/:user

  • Find rooms which requsest parameter's user is an element of 'userList', and return them as a response

• GET /room/roomId/:roomId

  • Find a room which its MongDB's id is same as request parameter's id, and return it as a response

• GET /room/:roomId/userList

  • Show userList of a room which attribute 'roomId' is same as request parameter's roomId

• POST /room

  • Make a new room with request body which is consist of title, makerId, mealType, maxUser, and makerId

• POST /room/addUser/:roomId

  • Add a new user in 'userList' of a room which attribute 'roomId' is same as request parameter's roomId

• PUT /room/:roomId

  • Update room information which attribute 'roomId' is same as request parameter's roomId

• GET /message

  • Show all messages in DB

• GET /message/bangjang/:bangjang

  • Find messages which attribute 'bangjang' is same as request parameter's bangjang, and return them as a response

• GET /message/requester/:requester

  • Find messages which attribute 'requester' is same as request parameter's requester, and return them as a response

• GET /message/specific/:roomId/:requester/:bangjangRead

  • Find a specific message which attribute 'roomId', 'requester', 'bangjangRead' are same as request parameter's roomId, requester, bangjangRead respectively, and return it as a response

• POST /message

  • Make a new message with request body which is consist of roomId, requester, bangjang, bangjangRead, accept

• POST /message/:roomId/:requester

  • Update message information which attribute 'roomId' and 'requester' are same as request paramter's roomId and requester respectively

Server Structure

• models/
  • schema.js : mongoDB Schema
• routes/
  • index.js : routing Server code
• views/
  • index.html : check whether server is alive
  • list.html : show list of availabe API requests
• app.js: main JavaScript Server code with socket.io Chat code
• package.json : include code dependencies