{"id":31771938,"url":"https://github.com/bookpanda/openexam","last_synced_at":"2026-04-11T19:02:51.386Z","repository":{"id":316943404,"uuid":"1045373461","full_name":"bookpanda/openexam","owner":"bookpanda","description":"Generating exam cheatsheets from lecture slides","archived":false,"fork":false,"pushed_at":"2025-09-27T17:44:22.000Z","size":115,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-27T19:31:22.149Z","etag":null,"topics":["aws","go","microservices","nextjs","python","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bookpanda.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-27T04:13:28.000Z","updated_at":"2025-09-16T11:36:39.000Z","dependencies_parsed_at":"2025-09-27T19:31:46.424Z","dependency_job_id":null,"html_url":"https://github.com/bookpanda/openexam","commit_stats":null,"previous_names":["bookpanda/openexam"],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/bookpanda/openexam","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bookpanda%2Fopenexam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bookpanda%2Fopenexam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bookpanda%2Fopenexam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bookpanda%2Fopenexam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bookpanda","download_url":"https://codeload.github.com/bookpanda/openexam/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bookpanda%2Fopenexam/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002604,"owners_count":26083426,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","go","microservices","nextjs","python","rust"],"created_at":"2025-10-10T03:49:36.001Z","updated_at":"2025-12-30T21:10:59.260Z","avatar_url":"https://github.com/bookpanda.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openexam\n\n## Stack\n\n- gateway (rust): axum, tonic\n- user (rust): tonic, postgres\n- cheatsheet (go): s3, dynamodb\n- generator (python): lambda, openai-api\n  - flow: frontend -\u003e s3 -\u003e sqs -\u003e generator -\u003e s3 -\u003e frontend\n- frontend (typescript): nextjs, tailwindcss\n\n![Microservices Design](./docs/microservice-design.png)\n\n## Getting Started\n\n### Running all services locally\n\nthis will run lastest images of all services\n\n1. Setup AWS infratstructure\n\n```bash\ncd terraform\nterraform init\nterraform apply\nterraform output secret_access_key\n# this will generate envs: access_key_id, secret_access_key, bucket_name\n```\n\n1. pull images used in `docker-compose.yml`\n\n```bash\n# note: if you are on apple silicon, you need to pull the amd64 images\n# amd64 e.g. x86_64 (force pulling amd64 images on apple silicon)\ndocker pull --platform=linux/amd64 ghcr.io/bookpanda/openexam-gateway:latest\ndocker pull --platform=linux/amd64 ghcr.io/bookpanda/openexam-user:latest\ndocker pull --platform=linux/amd64 ghcr.io/bookpanda/openexam-cheatsheet:latest\n```\n\n2. Copy `.env.template` and paste it in the same directory as `.env`. Fill in the appropriate values. `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`, `S3_BUCKET` are from the terraform output\n3. Run `docker compose up` to start the services.\n\n### Running services on the host\n\n- used when you need to make code changes to some services\n- you can comment out that service in root `docker-compose.yml` while working (but don't commit it)\n\n1. Copy `.env.template` and paste it in the same directory as `.env` for that service. Fill in the appropriate values.\n2. Follow the instructions in the service's README.md to run the service.\n\n### Deploying Lambda changes\n\n```bash\nsource .env.terraform \u0026\u0026 ./deploy_lambdas.sh\n```\n\n## API\n\nWhen run locally, the gateway url will be available at `localhost:3001`.\n\n- Swagger UI: `http://127.0.0.1:3001/swagger/`\n\n## Load Test\n```bash\ndocker-compose up\n\n# upload presign\ndocker run --rm -i -v \"$(pwd)/loadtest:/scripts\" -w /scripts grafana/k6:0.50.0 run upload_presign.js\n\n# get all files\ndocker run --rm -i -v \"$(pwd)/loadtest:/scripts\" -w /scripts grafana/k6:0.50.0 run get_all_files.js\n\n# generate\ndocker run --rm -i -v \"$(pwd)/loadtest:/scripts\" -w /scripts grafana/k6:0.50.0 run generate.js\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbookpanda%2Fopenexam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbookpanda%2Fopenexam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbookpanda%2Fopenexam/lists"}