Standards Alignment Tool (SALT)
Overview
This is a prototype for testing the IMS Global Learning Consortium® CASE™ Specification and proving its use in real-world scenarios based on various proof of concept and pilot projects.
The code is intended to run using a set of docker containers using docker-compose so that it can be easily deployed in any Linux environment with docker installed.
Installation
Note: the rest of the following can be automated by running
./local-dev/initial_dev_install.sh
Once the application is running: To create an organization use
./bin/console salt:org:add [organization name]To create a user use./bin/console salt:user:add [username] [--password="secret"] [--role="rolename"]The initial_dev_install.sh command creates an initial super admin "admin" with password "secret"
./bin/build.shalso does much of the following, for doing a "build" after one has started development
- Create env file and docker-compose file
cp docker/.env.dist docker/.env
ln -s docker/.env .env
ln -s docker-compose.dev.yml docker/docker-compose.yml
- Edit docker/.env and set desired values
- The
PORTspecified is what is used in step 7 below
- Start the application
make up
* To stop the application
```
make down
```
- Install libraries with composer/yarn and build application
make force-build
- Linux users should note that a new user group,
docker, has been created. The user that will interact with the Docker service will need to be in this group. - Linux users also set the MySQL folder permissions:
chmod -R 777 docker/data/mysql - Linux users should set the cache directory permssions:
chmod 777 var/cache
- Run database migrations
make migrate
- http://127.0.0.1:3000/app_dev.php/ should show the initial screen with debug turned on
- Note that the port here should be the value of
PORTin the.envfile (default being 3000)
- If you have run these manual tasks, you will also need to create the administrative account and password for the system:
./bin/console salt:user:add admin Unknown --password=secret --role=super-user