e-RATOS (Embeddable Remote Automatised Teaching and Controlling System)
This is a web-based application that provides a rich extensive toolset for students' knowledge control
via classical tests. The app can be used by medium and large educational organisations like schools, colleges or universities
in multiple or mixed knowledge domains: health care, linguistics, natural sciences, etc. with significant loading
like 10000+ learning sessions per day, with 1000+ simultaneous active sessions of 20-200 questions, accessed from
within any LTI 1.x-compatible LMS like edX, Moodle, Sakai, etc.
(LTI v 1.1 is deprecated and transition to LTI v1.3. is desired)
as well as directly from within Intranet or Internet network via a browser.
- Java 17;
- Spring Boot 3.x;
- Hibernate;
- RDBMS (MySql 8.x);
- Redis 7.x
- Maven;
- Junit 5 (Jupiter);
- TestContainers.
- React.js (sources here)
Varies depending on the scale of your organization: quantity of simultaneous users and quantity of questions. E.g. for an organization of 10000 concurrent students, and staff of 500 people with questions base of 500000+, minimal requirement is the following:
- RAM 16Gb, with heap size > 8Gb;
- Single quad core CPU;
Use tags:
- latest (for latest image)
- prod (for least stable image)
Warning!
You need to create a Docker hub account to access the image.
Docker file creation with Jib Maven plugin info:
- Set application.yml -> profile=stage/prod
./mvnw clean compile
[Jib requires compiled project]./mvnw jib:build -Djib.to.auth.username=${DOCKER_HUB_USERNAME} -Djib.to.auth.password=${DOCKER_HUB_PASSWORD}
(Specify you credentials from DockerHub)
- prod
- stage
- dev
Notes(!): prod profile is tied to AWS environment (see ElastiCache Redis config).
- Make sure to use JDK 17 in the project;
- Install EnvFile plugin;
SpringBoot config
- Add SpringBoot configuration
- Enable env. variable file
- Add env file as the .env file
- Set up MySql database locally (v 8.x)
- Run locally
Docker-compose config info:
- Add Docker-compose configuration
- Specify docker-compose.yml
- Specify .env variables file
- Run locally
BE only
- Install Docker runtime
- Install Docker-compose
- Put .env file with all required environment variables into the same folder where docker-compose.yaml is located.
- Run
docker compose up -d
to start the app; - Run
docker compose down
to stop the app;
Fullstack
- Run
docker-compose -f docker-compose-fullstack.yaml up -d
to start the fullstack app with front-end part;
(Make sure to use Java 17 as default system JDK)
export JAVA_HOME=/usr/lib/jvm/java-${JDK_VERSION_PACKAGE}
export PATH=$JAVA_HOME/bin:$PATH
java -version
Unit tests
./mvnw clean test
IT tests
By config, all test classes ending with *TestIT will be executed!
./mvnw clean verify
Local Terminal run
- Export env. variables from .env file
export $(grep -v '^#' .env | xargs)
- Run the app via Maven
./mvnw spring-boot:run
./mvnw flyway:clean -Dflyway.user=${DATABASE_USER} -Dflyway.password=${DATABASE_PASSWORD}
- clean local DB
./mvnw flyway:migrate -Dflyway.user=${DATABASE_USER} -Dflyway.password=${DATABASE_PASSWORD}
- migrate local DB
./mvnw flyway:validate -Dflyway.user=${DATABASE_USER} -Dflyway.password=${DATABASE_PASSWORD}
- validate local DB
(Specify you credentials from DB)
Alternatively, locate settings.xml (with DB credentials) in .m2 folder on local PC