siddharthchatterjee9 / vSTUDENT

Student upload portal for college - An API with numerous features starting from profile creation, forum chat, tags based assignment search; to car pooling and friend finder.

vStudent - API

An API for a student portal application made for project component of Object Oriented Software Development Course.

Requirements

1. Have maven installed and mvn added to path.
2. Have an instance of mysql server, prefereably running on localhost:3306

Running the code

1. Import the project from github
2. Open the application.properties file and modify the database user, password and url as needed.
3. In the project directory, open terminal and run the command mvn clean package
4. goto the target directory which must now contain a JAR file.
5. Run the jar file using java -jar filename.jar
6. Open localhost:8080/swagger-ui/index.html#/ for an api doc, and localhost:8080/v2/api-docs for a json version of docs.