Research Mentorship Backend

Springboot and MongoDB backend of DEV's unique solution that aggregates all the research opportunities on campus for all majors and departments. Key features include:

• Latest listings of student research positions,
• Administrative access for OSU faculties,
• And so much more...

This student project is made with passion and ❤️ by:

• Bennett Godinho-Nelson as Sr SWE
• D'Andre Williams as Sr SWE
• Suyeon Chae as Jr SWE
• Alex Eichner as Jr SWE
• Connor Radkov as Jr SWE
• Jerry Chang as Jr SWE
• Max Miller as Jr SWE

Documented on 03/21/24 by Keming He as the DevOps consultant for this project. Connect with me at https://linkedin.com/in/keminghe ⭐

Quick Start

🎉 As of 03/25/24, the backend is fully Docker-containerized by Keming as part 1 of the CI/CD project pipline.

Part two consists of automatic testing and build per commit to main, which is coming soon through GitHub Actions.

To build the backend yourself, you need to have Docker installed and fully setup with all the necessary permissions, the detailed guide for every OS can be found here:

Official link: https://docs.docker.com/get-docker/

After your successful setup, run these commands to pull (the build base), build, and run your image locally:

# Only need to run once, to fetch base images.
docker pull bellsoft/liberica-runtime-container

# Build the container image and store it locally.
# Feel free to create your own image name and tags.
docker build -t image-name:image-tag .

# Run your container and see output in browser.
# SpringBoot port convention is 8080,
# so don't forget to go to
# http://localhost:8080
docker run -p 8080:8080 image-name:image-tag

# And finally, stop and kill all the running containers.
set -e;
docker stop $(docker ps -q);
docker rm $(docker ps -a -q);

Note

For demonstration purposes, TODO: add illustration of backend routing and database design diagrams here.

Important

For common troubleshooting, as well as issue submission, please go to our issue board:

https://github.com/devosu/research-mentorship-backend/issues

For Developers

0. Git, Java, and Maven Set Up

Install the latest version of git version control on your local dev environment.

Official link: https://git-scm.com/downloads

Install Bellsoft's Java 17 LTS, we need an exact match this time.

Official link: https://bell-sw.com/pages/downloads/#jdk-17-lts

Install the latest version of Maven on your local dev environment.

Official link: https://maven.apache.org/users/index.html

Run these commands in a terminal/cmd/powershell to confirm installation success:

git --version
mvn --version   # Not 'maven' in full

You should see something printed out such as:

git version 2.34.1                          # For git (ver varies)
Apache maven 3.6.3                          # For Maven (ver varies)
Maven home: ...
Java version: 17.0.10, vendor: BellSoft,... # For Java (must be 17)
...

1. Clone the Repository

Open any termial and run:

git clone https://github.com/devosu/research-mentorship-backend.git

Tip

If you are a admin or contrib member of this repo, you should be able to clone it.

For Access Denied issues, please first consult: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens then @ any Officer in our Discord.

Once successfully cloned our repo, make sure to enter and create your own feature branch:

cd research-mentorship-backend
git pull
git checkout -b dev-feature_name-your_name

Yeah!! 😃 You are now ready! Let's give the server a test run, shall we? By default, the backend is packaged to the target directory; and the server is hosted to https://localhost:8080.

# Replace YOUR_PACKAGED_JAR with the actual name of the .jar file.
set -e; mvn clean; mvn package; java -jar target/YOUR_PACKEGED_JAR.jar

2. Let's Build

D'Andre, the floor is yours.

Happy Developing Everyone!