Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blocklune/csapp-lab-management-system

A practice project from NJUPT, built with Spring & NextJS
https://github.com/blocklune/csapp-lab-management-system

management-system nextjs spring

Last synced: 8 days ago
JSON representation

A practice project from NJUPT, built with Spring & NextJS

Host: GitHub
URL: https://github.com/blocklune/csapp-lab-management-system
Owner: BlockLune
Created: 2024-10-28T02:14:11.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-11-10T05:27:50.000Z (3 months ago)
Last Synced: 2025-01-22T22:43:12.316Z (15 days ago)
Topics: management-system, nextjs, spring
Language: TypeScript
Homepage:
Size: 1.22 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# CSAPP Lab Management System

This is a hands-on project from NJUPT's practice week. During this week I built a lab management system using Spring & NextJS.

## Preview

![login-page](./img/login-page.webp)
![student-dashboard](./img/student-dashboard.webp)
![student-solution](./img/student-solution.webp)
![teacher-dashboard](./img/teacher-dashboard.webp)
![teacher-lab](./img/teacher-lab.webp)
![teacher-student](./img/teacher-student.webp)

## Architecture

I built the backend, a RESTful API service, using Spring Boot. The API is protected with Spring Security and uses basic authentication and JWT. I use PostgreSQL as the database where I store information about labs, system users and their roles (teacher, student). The system uses an S3-compatible service to store lab materials and student solutions.

I built the frontend with NextJS. I use the Radix UI library to build components, Formik to handle forms, and Framer Motion for some animations.

## Deployment

### Backend

As mentioned above, the backend of the system uses PostgreSQL and an S3-compatible service. The design gives the system a high degree of flexibility. If you want to use your own services, please check out and modify the environment variables in the `.env' file of the backend project.

### Frontend

The frontend is a standard NextJS project. Check out the [NextJS documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more information.

### Docker Compose

I provide a `docker-compose.yml` file to deploy the whole system completely locally. It will not only start both the frontend and the backend of the system, of course. but also a local PostgreSQL server and a MinIO server. Here are the steps:

Before you start, make sure you have Docker installed on your machine. See the [Docker documentation](https://docs.docker.com/engine/install/) for installation instructions.

Create a directory for the project and run the following command to download the `docker-compose.yml` file:

```bash
curl -fsSL https://raw.githubusercontent.com/BlockLune/csapp-lab-management-system/refs/heads/main/docker-compose.yml
```

In the same directory, create an `.env` file with the following content:

```text
CSAPP_LAB_MANAGEMENT_SYSTEM_POSTGRES_DB=
CSAPP_LAB_MANAGEMENT_SYSTEM_POSTGRES_USER=
CSAPP_LAB_MANAGEMENT_SYSTEM_POSTGRES_PASSWORD=

CSAPP_LAB_MANAGEMENT_SYSTEM_MINIO_ROOT_USER=
CSAPP_LAB_MANAGEMENT_SYSTEM_MINIO_ROOT_PASSWORD=
CSAPP_LAB_MANAGEMENT_SYSTEM_MINIO_ACCESS_KEY_ID=
CSAPP_LAB_MANAGEMENT_SYSTEM_MINIO_SECRET_ACCESS_KEY=
CSAPP_LAB_MANAGEMENT_SYSTEM_MINIO_BUCKET_NAME=

CSAPP_LAB_MANAGEMENT_SYSTEM_INIT_TEACHER_USERNAME=
CSAPP_LAB_MANAGEMENT_SYSTEM_INIT_TEACHER_PASSWORD=
```

And then run the following command to start:

```bash
docker-compose up -d
```

As you can see, there are a lot of credentials to fill in the `.env` file. I provide a script named `deploy.sh` to generate these credentials. Run the following command to download the script:

```bash
curl -fsSL https://raw.githubusercontent.com/BlockLune/csapp-lab-management-system/refs/heads/main/deploy.sh
```

I also provide a script named `start.sh` to start the services:

```bash
curl -fsSL https://raw.githubusercontent.com/BlockLune/csapp-lab-management-system/refs/heads/main/start.sh
```

And a script named `stop.sh` to stop the services:

```bash
curl -fsSL https://raw.githubusercontent.com/BlockLune/csapp-lab-management-system/refs/heads/main/stop.sh
```

## Util Scripts

In NJUPT, students need to use the system to view lab information and submit lab solutions, but they also need to ssh to the school server to do their labs. So, here comes a script for quick batch creation of student accounts in this system and in the server. All you need to do is make sure that a file named `students.csv` exists in your current directory and run the following script (see the comments within the script for more details):

```bash
sudo python add_students.py
```

Notice: The CSV file should contain columns:

- student_id: Student's ID that will be used as both this system's username and Unix username
- password: Student's password that will be set for both this system's and Unix account

## Development Notes

- File structure in S3-Compatible Service:

```text
labs/
└── {labId}/
├── materials/
│ └── {fileName}
└── solutions/
└── {studentId}/
└── {fileName}
```

- Error / exception handling are done in the `GlobalExceptionHandler`.
- Basically the `deleteFile` interface of the OSS service always returns 200 (OK), since if the file exists, it will be deleted, and if it doesn't exist, it is some kind of "deleted".
- MinIO needs path-style access.