RAISE Onboarding Portal Experience (ROPE)

ROPE aims to streamline the onboarding of RAISE adopters.

Development

The repo includes a docker environment which can be launched as follows:

Set your GOOGLE_CLIENT_ID, MOODLE_URL, and MOODLE_TOKEN as desired using the following commands:

$ export GOOGLE_CLIENT_ID=<client_id>
$ export MOODLE_URL=<moodle_url>
$ export MOODLE_TOKEN=<moodle_token>

If you would like to test with AWS you can optionally set the credentials using the set_aws_creds script in aws-access/scripts and you can set the SQS and S3 environment variable using the following command:

$ export SQS_QUEUE=<SQS_QUEUE>
$ export COURSES_CSV_S3_BUCKET=<COURSES_CSV_S3_BUCKET>
$ export COURSES_CSV_S3_KEY=<COURSES_CSV_S3_KEY>

$ docker compose up --build -d -V

Once running, the application components can be accessed at the following URLs:

Frontend: http://localhost:3000
Backend API (docs): http://localhost:3000/api/docs

A user can be added to the database by running the following command:

$ docker compose exec postgres psql -U pguser -d ropedb -c "INSERT INTO user_account (email, is_manager, is_admin, created_at, updated_at) VALUES ('user@email.com', false, true, now(), now());"

Devs can also test the deployment build of the frontend by running the following:

$ ROPE_APP_TARGET=deploy docker compose up --build -d -V

When developing backend code, developers may want to install the package in an editable virtual environment. That can be done as follows (to avoid unresolved imports per this issue). If the imports remain unresolved, the language server may need to be restarted:

$ pip install -e .[test] --config-settings editable_mode=strict

Code coverage reports can be generated when running tests:

$ pytest --cov=rope --cov-report=term --cov-report=html

openstax/rope

RAISE Onboarding Portal Experience (ROPE)

Development