{"id":20282794,"url":"https://github.com/sentrionic/mirage","last_synced_at":"2026-05-07T02:35:26.519Z","repository":{"id":117088427,"uuid":"378704735","full_name":"sentrionic/Mirage","owner":"sentrionic","description":"Small Twitter clone to learn testing and Jetpack Compose","archived":false,"fork":false,"pushed_at":"2022-10-14T08:23:39.000Z","size":17450,"stargazers_count":0,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-07T01:35:50.891Z","etag":null,"topics":["android","gin-gonic","go","jetpack-compose"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sentrionic.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":"2021-06-20T17:37:05.000Z","updated_at":"2024-08-15T09:01:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"484228c4-ee76-43cb-b420-5de7cb32cf82","html_url":"https://github.com/sentrionic/Mirage","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sentrionic/Mirage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentrionic%2FMirage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentrionic%2FMirage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentrionic%2FMirage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentrionic%2FMirage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sentrionic","download_url":"https://codeload.github.com/sentrionic/Mirage/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentrionic%2FMirage/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32720410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["android","gin-gonic","go","jetpack-compose"],"created_at":"2024-11-14T14:11:58.912Z","updated_at":"2026-05-07T02:35:26.505Z","avatar_url":"https://github.com/sentrionic.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mirage\n\nMirage is a small [Twitter](https://twitter.com/) clone used to learn testing and [Jetpack Compose](https://developer.android.com/jetpack/compose).\n\n## Screenshots\n\n\u003ctable\u003e\u003ctr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/auth.gif\" width=\"180\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/home.gif\" width=\"180\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/postdetail.png\" width=\"180\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/create.gif\" width=\"180\"\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/profile.gif\" width=\"180\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/search.gif\" width=\"180\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/account.gif\" width=\"180\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"./assets/darkmode.png\" width=\"180\"\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003c/table\u003e\n\n## Features\n\n- Tweet CRUD\n- Following System\n- Search by username or hashtags\n- Retweet-Lite\n- Business Logic fully tested\n- E2E Testing (backend)\n\n## Stack Backend\n\n- [Gin](https://gin-gonic.com/) for the REST server\n- [Gorm](https://gorm.io/) as the database ORM\n- PostgreSQL\n- Redis\n- S3 for storing files\n- Github Actions to test on every commit\n\n## Stack Mobile\n\n- [Jetpack Compose](https://developer.android.com/jetpack/compose) to create the views\n- [Retrofit](https://square.github.io/retrofit/) for HTTP Requests\n- [Android Room](https://developer.android.com/training/data-storage/room) as the cache\n- [Hilt](https://developer.android.com/training/dependency-injection/hilt-android) for depencency injection\n\nThe app structure is based on [codingwithmitch's compose course](https://github.com/mitchtabian/food2fork-compose).\n\n---\n\n## Installation\n\n### Server\n\n(If you are familiar with `make`, take a look at the `Makefile` to quickly setup the following steps)\n\n1. Install Docker and get the Postgresql and Redis containers\n2. Create a DB\n3. Install Go 1.19 and get all the dependencies (`go mod tidy`)\n4. Rename `.env.example` to `.env` and fill in the values\n\n- `Required`\n\n        PORT=8080\n        DATABASE_URL=\"postgresql://\u003cusername\u003e:\u003cpassword\u003e@localhost:5432/db_name\"\n        REDIS_URL=redis://localhost:6379\n        CORS_ORIGIN=http://localhost:3000\n        SECRET=SUPERSECRET\n        HANDLER_TIMEOUT=5\n        MAX_BODY_BYTES=4194304 # 4MB in Bytes = 4 * 1024 * 1024\n        COOKIE_NAME=mqk\n        DOMAIN=DOMAIN\n\n- `Optional: Not needed to run the app, but you won't be able to upload files.`\n\n        AWS_ACCESS_KEY=ACCESS_KEY\n        AWS_SECRET_ACCESS_KEY=SECRET_ACCESS_KEY\n        AWS_STORAGE_BUCKET_NAME=STORAGE_BUCKET_NAME\n        AWS_S3_REGION=S3_REGION\n\n5. Run `go run github.com/sentrionic/mirage` to run the server\n\n### App\n\n1. Clone the repository and open the `app` directory in Android Studio.\n2. Set the `BASE_URL` in `Constants.kt`. If the backend runs locally, make sure to also add `android:usesCleartextTraffic=\"true\"` to the Android Manifest.\n3. Run the app.\n\n---\n\n## Testing\n\n### Server\n\n1. To test the business logic in the handler and service directories run `go test -v -cover ./service/... ./handler/...` (or `make test`).\n\n2. To test the routes, run `go test -run '^\\QTestMain_E2E\\E$\\'` (or `make e2e`)\n\n### App\n\nTo run the use case tests simply right click the `app` directory in the `test` directory and select `Run tests in 'xyz.mirage...'`\n\n---\n\n## Known Issues\n\n### App\n\n- Backstack keeps growing.\n  - Haven't found a good solution to that problem yet.\n- Screen transition animations flicker white when using dark mode.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsentrionic%2Fmirage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsentrionic%2Fmirage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsentrionic%2Fmirage/lists"}