Skip to content

Latest commit

 

History

History
135 lines (97 loc) · 3.62 KB

README.md

File metadata and controls

135 lines (97 loc) · 3.62 KB
Raw

Thesis Management System Frontend Server

Installation and Booting

From this folder, run the following commands:

npm install
npm start

This will install all the dependencies and start the server on port 3000.

Users Credentials

API Interface

All API interfaces are in the src/api folder. The API interfaces are placed in different files based on the resource they are related to.

A config file is present in src/api/config.js which contains the base URL of the backend server. This can be changed if the backend server is running on a different port. Also, the config file contains the headers to be sent with each request. Currently, it contains the Content-Type header.

API Usage

The API interfaces can be used in the following way using then/catch:

import AuthenticationAPI from "../api/AuthenticationAPI";

const fetchLogin = () => {
    AuthenticationAPI.login('admin', 'admin')
        .then(async response => {
            let data = await response.json();

            if (response.ok) {
                console.log("token: " + data.token);
            } else {
                console.error("error: " + data.error);
            }
        })
        .catch(error => {
            console.error("error in fetch login: " + error);
        });
};

  • getAllProposals

    It is used to get all the proposals referred to the degree attended by the logged Student.

    • Parameters: none

    • Return value:

      {proposals: [
    {
        proposal_id: "P002",
        title: "Machine Learning",
        supervisor_surname: "Wilson",
        supervisor_name: "Michael",
        keywords: [
            "Machine learning",
            "AI"
        ],
        type: "Master",
        groups: [
            "Group B"
        ],
        description: "Proposal description",
        required_knowledge: "Python, TensorFlow",
        notes: "N/A",
        expiration_date: "2024-06-29T22:00:00.000Z",
        level: "Graduate",
        degrees: [
            "Master of Science"
        ]
    },
    {
        ...
    },...
    ]
}

      It can also return an error in case of failure on backend side.

Pages

All pages are in the src/pages folder. The pages are placed in different files based on the resource they are related to.

HomePage

The home page is in src/pages/HomePage.js.

ProfilePage

The user profile page is in src/pages/ProfilePage.js.

LoginPage

The login page is in src/pages/LoginPage.js.

ProposalsPage

The proposals page is in src/pages/ProposalsPage.js.

The route is accessible at /proposals.

ProposalDetailsPage

The proposal details page is in src/pages/ProposalDetailsPage.js.

The route is accessible at /proposals/:proposalId.

StudentApplicationPage

The student application page is in src/pages/StudentApplicationPage.js.

The route is accessible at /applications/ when the user is logged in as a student.

ApplicationsDetailsPabe

The application details page is in src/pages/ProposalDetailsPage.js.

The route is accesible at /applications/:application_id.

ThesisRequestPage

The thesis request page is in src/pages/ThesisRequestDetailsPage.js.

The route is accessible at /proposals/requests/new.