Language: English | 中文

Front-end address

Table of Contents

• Background
• Features
  • For teachers
  • For students
• Getting Started in IDE
• Development Environment
  • Prerequisites
  • Installation and usage
• Deployment Environment
  • Local
  • Remote (not yet)
• Maintainers
• Contributing
• License

Background

When students are seniors, they need to choose their graduation design tutor to help them complete their graduation design. And the teachers have their rights to determine which students can choose them as tutor. So they can set requirements, and only the students who meet all of the requirements the teacher set can choose the teacher as their graduation design tutor. And of course, different teachers have different requirements and the maximum number of students they can help.

So the graduation design tutor selection tool is aiming to help students and tutors choose each other conveniently. Further more, this tool will first be tried to be used by Bo Wang, Lecturer in Software Engineering, Northeast Forestry University:school: and his students.

Features

For teachers

• Set their requirements beforehand on the website.
• Import students information form Excel files.

For students

• Submit their information, like GPAs, and directions of graduation design to check whether they can choose this teacher.

Getting Started in IDE

This project hasn't been deployed in remote server yet, but by doing the following steps, you can get started in your IDE, and then if you find some bugs or want to add some new features, you can open an issue or submit pull requests. 😃

Prerequisites

The following is required to be installed in your machine

• Java 11 or newer
• Git command line tool
• Your preferable IDE, like Intellij IDEA
• Maven (strongly recommended, it can help you install the package needed in the project)
• MySQL 8.0 or newer

Installation and usage

1. Click the 'Clone or download' button on the GitHub repository page, and copy the url of the code repository.

2. Open the Git command line tool and input the following Git command:

   git clone <the url you just copyed>
   

3. Use your preferable IDE to import this project by importing the Maven pom.xml file.

   Take Intellij IDEA as an example:

   File -> New -> Project form Exsisted Sourses... -> choose the pom.xml file in the project folder
   

4. Use Maven to reimport all the dependencies.

5. Modify the database configurations in application.propertieslocated in tutor-selection-tool\src\main\resources\.

6. Deploy in your local server and launch the project.

7. Open your web browser to enjoy it ~

Development Environment

• Intellij IDEA - v2020.1 EAP
• OpenJDK - v11.0.6
• Spring Boot - v2.2.5
• Junit - v5
• Slf4j
• Lombok
• MySQL - v8.0
• Spring Data JPA - v2.2.5
• Maven - v3.6.1
• Git - v2.24

Deployment Environment

Local

• Server: Tomcat v9.0.27
• Database: MySQL - v8.0

Remote

• Docker - v2019.03

Maintainers

• @Erjian Gao - student in Software Engineering, Northeast Forestry University

Contributing

Feel free to join in! Open an issue or submit pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details

MIT © Erjian Gao