1.) Install Java JDK 11+. JDK located here. If you have a Mac you can use brew
.
brew install java
2.) Create your personal repository from Github. You should receive a unique link from your professor from Github Classroom that will generate a private repository within your Github account. It should look something like this.
https://classroom.github.com/a/{classroomId}
3.) This will create your personal repository within the Citadel CS Github Organization.
4.) Clone down the repository from Github
git clone git@git.github.com:CitadelCS/csci-602-fall-2021-{yourUsername}.git
5.) Build the project
./mvnw clean install
You should see a success if everything is set up correctly.
6.) Run the API
./mvnw spring-boot:run
Access the API by visiting http://localhost:5000/swagger-ui/index.html. From there you can hit the endpoints directly.
7.) Success!
For further references with Spring Boot:
For further references with Maven's dependency management framework: