CS411 Project Track 1 Repo

Project Structure

• bin: js file for starting the nodeJS server
• client: ReactJS application project file
• db: database file. db.sql is for database establishment
• routes: backend API routers, including the implementation
• app.js: main file of application
• package.json (package-lock.json): dependencies and configuration

Deployment

• Operating System: Linux

1. Install Backend Dependencies:

npm install  

2. Install Frontend Dependencies:

cd client  
npm install  

3. Build the Frontend

npm run build  

4. Start the server

cd ..  
npm start  

5. Create mysql database (see db/db.sql)

Development Environment

• Frontend: ReactJS + MaterialUI
• Backend: NodeJS Express
• Development Server: NodeJS
• IDE: WebStorm
• Database: mysql

Open the directory ./ and ./client in WebStorm respectively in order to develop backend and frontend

Demo

Interface and data format Specification

POST /users/login

Request  
{  
 "email": "", "password":"",}  

Response Body

{  
 "error": 0, "data": [ { "id": "goo", "first_name": "goo", "last_name": "goo", "email": "goo@illinois.edu", "password": "goo", "created_at": "2018-10-31T02:50:14.000Z", "type": "student" } ], "token": ""}  

POST /users/register

Request

{  
  "first_name":"",  
  "last_name":"",  
  "email":"",  
  "password":""  
}  

Response Body

{  
 "error": "", "data": "", "token":""}  

GET /students/course-selected/:userID

Each course has two shedule_id.

{
    "error": "",
    "data": [
        {
            "crn": 411,
            "title": "Database Systems",
            "enrolled_num": 1,
            "capacity": 1,
            "start_time": [
                "13:15:00",
                "13:15:00"
            ],
            "end_time": [
                "15:30:00",
                "15:00:00"
            ],
            "weekday": [
                "W",
                "M"
            ],
            "location": [
                "siebel",
                "siebel"
            ]
        },
        {
            "crn": 436,
            "title": "Computer Network",
            "enrolled_num": 1,
            "capacity": 1,
            "start_time": [
                "11:15:00",
                "11:15:00"
            ],
            "end_time": [
                "12:30:00",
                "12:30:00"
            ],
            "weekday": [
                "W",
                "M"
            ],
            "location": [
                "siebel",
                "siebel"
            ]
        }
    ]
}

GET /students/course-unselected/:userID

Like course-selected

POST /students/course-register

Transaction created. Request:

{  
“user_id”:””,  
“crn”:””  
}  

Response:

{  
 "error": "", "data": "success"}  

POST /students/course-drop

Transaction created. Request:

{  
“user_id”:””,  
“crn”:””  
}  

Response:

{  
 "error": "", "data": "success"}  

POST /professors/create-course

Transaction created. Request:

{
	"crn": 436,
	"user_id": "Matt",
	"title": "Computer Network Lab",
	"capacity": 1,
	"description": "Useful course",
	"start_time": ["14:15", "14:15"],
	"end_time": ["15:30", "15:30"],
	"weekday": ["W", "M"],
	"location": ["siebel", "siebel"]
}

Response:

{  
 "error": "", "data": "success"}  

POST /professors/delete-course

Request:

{  
"crn": [integer],  
}  

Response:

{  
 "error": "", "data": "success"}  

POST /professors/edit-course

The same as create-course Request:

{
	"crn": 436,
	"user_id": "Matt",
	"title": "Computer Network Lab",
	"capacity": 1,
	"description": "Useful course",
	"start_time": ["14:15", "14:15"],
	"end_time": ["15:30", "15:30"],
	"weekday": ["W", "M"],
	"location": ["siebel", "siebel"]
}

Response:

{  
 "error": "", "data": "success"}  

POST /professors/assign-score

Request:

{  
"grade": [integer],  
"user_id":""  
"crn":"",  
"type": "student"  
}  

Response:

{  
 "error": "", "data": "success"}  

POST /professors/course-info

Request:

{  
"user_id":  
}  

Response:
Each course has two schedule_id

{
    "error": "",
    "data": [
        {
            "crn": 436,
            "title": "Computer Network Lab",
            "enrolled_num": 0,
            "capacity": 1,
            "start_time": [
                "14:15",
                "14:15"
            ],
            "end_time": [
                "15:30",
                "15:30"
            ],
            "weekday": [
                "W",
                "M"
            ],
            "location": [
                "siebel",
                "siebel"
            ]
        }
    ]
}

POST /courses/course-detail

Request:

{  
"crn": [integer]  
}  

Response:

{
    "error": "",
    "data": [
        {
            "crn": 436,
            "user_id": "Matt",
            "title": "Computer Network Lab",
            "description": "Useful course",
            "capacity": 50,
            "enrolled_num": 1,
            "schedule_id": 1,
            "start_time": "11:15:00",
            "end_time": "12:30:00",
            "weekday": "W",
            "location": "siebel"
        },
        {
            "crn": 436,
            "user_id": "Matt",
            "title": "Computer Network Lab",
            "description": "Useful course",
            "capacity": 50,
            "enrolled_num": 1,
            "schedule_id": 2,
            "start_time": "13:15:00",
            "end_time": "14:30:00",
            "weekday": "M",
            "location": "siebel"
        }
    ]
}

GET /forum/review/:post_id

{
    "error": "",
    "data": [
        {
            "review_id": 1,
            "created_at": "2018-11-27T17:45:09.000Z",
            "content": "this is a test review",
            "endorsed": 0,
            "creator": "chenzhu",
            "post_id": 1
        }
    ]
}

POST /forum/review

Req:

{
	"post_id": 1,
	"creator": "chenzhu",
	"content": "this is a test review",
	"endorsed": 0
}

Res

{
    "error": "",
    "data": "New Review Added"
}

PUT /forum/review Req:

{
	"review_id": 1,
	"creator": "chenzhu",
	"content": "this is a test review",
	"endorsed": 0
}

Res

{
    "error": "",
    "data": "Review Modified"
}

DELETE /forum/review/:review_id

Res

{
    "error": "",
    "data": "Review Deleted"
}

---

Oct 29 11:30 pm, chen zhu:

• add student api

Oct.16 10:30 pm, chen zhu:

• Create frontend project
• Implement Login and Register UI
• deployment completed

---

Oct.12 10:17 pm, chen zhu:

• Created the repo
• Created SQL file in /db/db.sql
• User API: /users/getUsers, /users/login, /users/register added
• TOFIX: add token authentication,