Requires Docker installation
To run an instance of Shifty simply ensure that Docker is installed and from the root directory (the one with the Dockerfile) use the following command ./setup.sh. Docker requires sudo privileges and will request the sudo password.
The setup process may take some time, feel free to grab a coffee, you earned it!
Once running the shifty api will be directly accessed through localhost:8080/shiftyspring/api.
To run on windows please consider using cygwin, babun or similar command line environment and run the setup.sh script; unlike in Linux or OSX there is no need to provide sudo permissions.
The supplied setup batch file will setup the Docker containers and serve APIman and the shifty service, though the rest will require manual configuration.
Alternatively the commands can be run manually in the command line or powershell as shown below:
PS C:\git\shiftyspring> mvn clean package
PS C:\git\shiftyspring> docker-compose build
PS C:\git\shiftyspring> docker-compose up
- HATEOS API and domain model (20%)
- Usability of HTML/Javascript front-end (20%)
- Authentication implementation e.g. Keycloak(10%)
- API Limiting and policies using APIman (10%)
- Persistence of data (20%)
- Completeness of automated tests of the business logic (20%) Rest tests have been provided using postman
- Automation of deployment: Bash script
Current completion 90%