The management app (also called Basic Management App or BMA) serves as an interface for researchers to submit and members to approve study proposals.
It’s responsible for:
- Researcher creates/modifies/deletes study
- Member is notified when a study proposal is submitted
- Researcher is notified when study is approved
- Member reviews/approves/denies study
- Reports study status in response to enclave's SetupApp requests
Note: For developing locally without docker compose, you will need to install postgresql and add a .env file that contains a valid DATABASE_URL to access it.
Set these two environment variables with your Clerk secrets:
export NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_....
export CLERK_SECRET_KEY=sk_test_....And then you can use Docker compose to run the app and a postgresql database by using:
docker compose up
Other useful commands:
For developing locally without docker compose, you will need to install postgresql and add a .env file that contains a valid DATABASE_URL to access it.
Otherwise you can use Docker compose to run the app and a postgresql database by using:
docker compose up
Other useful commands:
docker compose buildwill rebuild the docker image, needs to be ran after packages are installeddocker compose exec mgmnt-app ./bin/migrate-dev-dbruns migrations (needs runningdocker compose upat same time)docker volume rm management-app_pgdatawill delete the database, allowing it to be migrated freshlydocker compose down -v --rmi all"reset switch" (e.g. on DB errors) this command stops and removes Docker containers, networks, volumes, and all images used by the Docker Compose services.
Open http://localhost:4000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
This project uses next/font to automatically optimize and load Inter, a custom Google Font.
- Api routes are protected by an authorization header containing a JWT Bearer which is signed with a RSA private key held be the member. The public key is stored in the members record accessed at the admin page at /admin/members
To generate a public private key you can run:
openssl genpkey -algorithm RSA -out private_key.pem -pkeyopt rsa_keygen_bits:4096
openssl rsa -pubout -in private_key.pem -out public_key.pemTo learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
[https://dev.to/aws-builders/how-to-package-and-deploy-a-lambda-function-as-a-container-image-3d1a] How to package and deploy a Lambda function as a container image [https://docs.aws.amazon.com/cdk/v2/guide/serverless_example.html] Tutorial: Create a serverless Hello World application
The new way to deploy is from the IaC repo, run:
./bin/deploy-lambda -p <AWS CLI profile> -c <management app dir> -a managementAppThere are a few CLI applications to debug the API end endpoints:
- npx tsx bin/debug/fetch-runnable.ts -u https://pilot.safeinsights.org/ -m openstax -k
- npx tsx bin/debug/set-status.ts -o https://pilot.safeinsights.org -m openstax -k -s <status: RUNNING | ERRORED> -r
- npx tsx bin/debug/upload-results.ts -o https://pilot.safeinsights.org -m openstax -k -r -f
Currently it is possible to upload results and then set status back to RUNNING to force the run to re-appear in the runnable api results and repeatedly upload files. while useful for testing, do not depend on that behaviour: it's likely we'll not allow it in later versions.