{"id":23289872,"url":"https://github.com/biscgit/enigma","last_synced_at":"2025-04-06T17:17:55.034Z","repository":{"id":246964909,"uuid":"824709755","full_name":"Biscgit/Enigma","owner":"Biscgit","description":"An enigma Website written with Dart and Python","archived":false,"fork":false,"pushed_at":"2024-07-29T20:28:09.000Z","size":733,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T23:18:45.359Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Biscgit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-07-05T18:43:52.000Z","updated_at":"2024-07-29T20:28:13.000Z","dependencies_parsed_at":"2024-07-06T02:05:19.445Z","dependency_job_id":null,"html_url":"https://github.com/Biscgit/Enigma","commit_stats":null,"previous_names":["biscgit/enigma"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Biscgit%2FEnigma","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Biscgit%2FEnigma/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Biscgit%2FEnigma/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Biscgit%2FEnigma/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Biscgit","download_url":"https://codeload.github.com/Biscgit/Enigma/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247517920,"owners_count":20951720,"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","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":[],"created_at":"2024-12-20T04:19:45.943Z","updated_at":"2025-04-06T17:17:55.016Z","avatar_url":"https://github.com/Biscgit.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Enigma\n\nThis a sligly modified Version of the original repo: an University project to develop the Enigma-Machine. \nThe frontend is created with Flutter Web on nginx and the Backend ist mostly written in Python.\n\n\u003e [!IMPORTANT]\n\u003e The goal of this project was to create a working Enigma with some defined features.\n\u003e This program is **not secure** in any way (not required!) and should not be used for more than learning!\n\u003e **NO WARANTIES given on anything in this repository!**\n\n### Infos\n\n- Website can be accessed on `http://localhost:8080` hosted with Nginx.\n- Login for GitLab registry builds: `docker login registry.mygit.th-deg.de`\n- Use a screen with resolution of at least 1920x1080 (zoom 100%) for best experience.\n\n### Platforms\n\n##### Linux\n\n- Everything works out of the box\n\n##### Windows\n\n- Go to `frontend/flutter.env` and change `IP_FASTAPI=` to `localhost`\n\n##### MacOS\n\n- Ask Apple support\n\n### Run Enigma\n\n- `docker compose up`\n\n### Run Enigma without GitLab\n\n- `docker compose -f docker-compose.fullylocal.yml up --build` (Note: Fully local building can take a\n  long time depending on Internet speed!)\n\n### Run E2E Tests\n\n- Launch `chromedriver`(chrome) or `geckodriver`(firefox) on `--port=4444`\n- In `/frontend` run `flutter drive --target=test_driver/app.dart -d web-server --release`\n- Append `--browser-name=firefox` to use an actually good browser (instead of Chrome) and increase performance by\n  3x–3.5x.\n\n### Other Commands\n\n- **Run** GitLab: `docker compose up --build -d`\n- **Run** Locally (for development): `docker compose -f docker-compose.local.yml up --build -d` (Note: Clean building\n  takes **3 to 8 Minutes!**)\n- **Stop** Compose: `docker compose down`\n- **Stop** and purge all: `docker compose down --rmi all --volumes` (Removes **all containers** and **database storage!\n  **)\n- **Restart**\n  clean: `docker compose -f docker-compose.local.yml down --rmi all --volumes \u0026\u0026 docker compose -f docker-compose.local.yml up --build -d`\n\n### Flutter commands\n\ngo to `/frontend` directory\n\n- **Run** Linter: `flutter analyze`\n- **Run** Flutter (with hot reload, compose needs to run in addition!): `flutter run -d chrome`\n- **Run** Flutter tests (visible: only Chrome. **Automated scrolling does not work on Chrome with screen!** Issue in\n  Chrome and not code): `flutter driver --target=test_driver/app.dart -d chrome --no-headless`\n- **Run** Flutter tests (headless, simple): `flutter --target=test_driver/app.dart -d web-server --release`\n- **Run** Flutter tests NEW (headless,\n  pipeline): `flutter driver --target=test_driver/app.dart -d web-server --release --browser-name=firefox`\n- **Run** Flutter tests OLD (headless,\n  pipeline): `flutter driver --target=test_driver/app.dart -d web-server --release --web-browser-flag=\"--disable-gpu --headless --window-size=1920,1080 --disable-infobars --disable-dev-shm-usage\"`\n- **Start** Chrome driver (before tests): `chromedriver --port=4444`\n- **Start** Firefox driver (before tests): `geckodriver --port=4444` [`\u0026\u003e driver.log`]\n\n### Backend commands\n\ngo to `/backend` directory\n\n- **Run** Backend unit/integration tests: `pytest --cov` (have all packages from `requirements.testing.txt` installed)\n- **Run** Linter: `ruff check`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiscgit%2Fenigma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbiscgit%2Fenigma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiscgit%2Fenigma/lists"}