...
The Shared Collection Service Bus (SCSB) is a middleware application deployed in AWS. Environment details are listed below:
Service | Consumer | Link | Comments |
|---|---|---|---|
SCSB UI |
All |
SCSB's Graphical User Interface (GUI). Primarily used by the development team for initial deployment and unit testing purposes. | |
SCSB Swagger |
All |
SCSB's REST APIs are exposed through this port. Swagger documentation provides information on API parameters and lets users try the services. Primarily used by the development team for initial deployment and unit testing purposes. | |||
SCSB UI (Test) | All | SCSB's Graphical User Interface (GUI). Primarily used by the quality and functional teams for system and functional testing. | |
SCSB Swagger (Test) | All |
SCSB's REST APIs are exposed through this port. Swagger documentation provides information on API parameters and lets users try the services. Primarily used by the quality and functional teams for system and functional testing. | |
SCSB UI (UAT) | All |
SCSB's Graphical User Interface (GUI). Primarily used by partners to complete User Acceptance Testing | |
SCSB Swagger (UAT) | All |
SCSB's REST APIs are exposed through this port. Swagger documentation provides information on API parameters and lets users try the services. Primarily used by partners to complete User Acceptance Testing |
Development Environment
The first thing a developer will need to do is to setup the development environment. It is common for developers to be working in different environments (Windows, Linux, Mac OS etc..) especially on open source projects and distributed teams. In order to set up a development environment which typically would involve installing softwares like Java, MySQL, tomcat, PHP etc, it can take up anywhere from hours to days depending on what all is required.
To minimize the effort and to ensure every developer is working with the same software versions (i.e development environment), we are going to use Docker Containers to install the "ReCAP Dev Environment".
...
In order to install Docker, please visit https://docs.docker.com and follow the instructions for your Operating System (Mac, Linux, Windows etc..)
...
You need to have a github account before you can do this. The main repo is at https://github.com/ResearchCollectionsAndPreservation/docker.
Once forked, clone the repository onto your local machine by following the steps below;
- Create a directory in your file system: mkdir recap-middleware
- git clone https://github.com/**username**/docker.git
Once the repository has been downloaded, change into the directory. You will see a folder called docker.
...
- docker ps -a
- docker ps -aq | xargs docker rm -f
...
- docker rmi -f $(docker images -q)
...
- docker build -t scsb-dev . - Here scsb-dev is the image name; you can name it whatever you like. The . indicates the current directory where the Dockerfile.
...
- docker build -t scsb-etl .
...
- docker run -i -t scsb-dev /bin/bash
...