JWT based security implemented API starter project
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them
- OpenJDK - Download & Install
- Docker - Download & Install
- run
compose.sh
shell script to build PostgreSQL and pgAdmin containers
$ cd database
$ ./compose.sh
- run
run.sh
shell script to start PostgreSQL and pgAdmin containers
$ cd database
$ ./run.sh
- examples above are given for
Linux/Unix
environment, for Windows use.bat
versions of shell scripts
- URL:
localhost:5432
- Username: postgres
- Password: password
- URL: http://localhost:5050
- Username:
[email protected]
- Password:
password
- Host name/address:
postgres-container
- Port:
5432
- Username:
postgres
- Password:
password
$ ./gradlew test
with test
$ ./gradlew clean build
without test
$ ./gradlew bootJar
run
$ ./gradlew bootRun
or, after running build command run
$ java -jar build/libs/spring-boot-api-seed-1.0.0-RELEASE.jar
- API - http://localhost:8000/api
- Health Check - http://localhost:8000/api/actuator/health
- Swagger API Documentation - http://localhost:8000/api/swagger-ui.html
- SpringBoot - Web Framework
- Gradle - Dependency Manager
- PostgreSQL - Open Source Relational Database
- Docker - Containerized Platforms
We use SemVer for versioning. For the versions available, see the tags on this repository.