A fully functional and secure RESTful Backend API for automating the management of university students’ Industrial training program (aka SIWES). SIWES is a mandatory industrial training program for undergraduate students in Nigeria, organized by Industrial Training Fund (ITF)
- Java: 1.8
- Spring Boot: 2.4.5
- H2 Database
- Hibernate
- Spring Fox: 3.0.0
A built jar file of the project has been included in the build_v4 folder.
To run the included jar file, open a terminal on the same folder where the jar file is located and execute the following command:
java -jar ITF-eLogbook-Webservice.jar.
The running application can be accessed at localhost:9092.
If necessary, you can edit the application.properties file and then build a new jar file by running the maven command: mvn package.
This project was developed using an embedded filebase H2 database. Once the application starts running, the database directory will automatically be created on the same location as the running jar file. The database GUI can be accessed at localhost:9092/h2-console with the following credentials:
- Driver class :
org.h2.Driver - JDBC URL :
jdbc:h2:file:./data/itflogbook - User Name :
logbook - Password :
logbook
This project uses swagger dependencies to generate beautiful html based documentations for the APIs. The documentations can be accessed at
http://localhost:9092/swagger-ui/index.html
This project uses bearer token based security to authenticate most of the requests. After login, a token is returned and such token are expected in subsequent requests for authorization. Authenticated requests also expected a header called x-client-request-key with value of kdnonoeno#@2lsn. These functionalities can be changed in the application.properties file.
username: [email protected]
password: admin1234