{"id":22874406,"url":"https://github.com/thesurlydev/images","last_synced_at":"2025-03-31T12:43:14.711Z","repository":{"id":211128311,"uuid":"719688187","full_name":"thesurlydev/images","owner":"thesurlydev","description":"A distributed asynchronous image processing service using Kotlin, Spring Boot, and NATS.","archived":false,"fork":false,"pushed_at":"2024-02-11T23:39:56.000Z","size":3673,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-06T18:52:28.361Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thesurlydev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2023-11-16T17:38:29.000Z","updated_at":"2024-07-17T19:03:51.000Z","dependencies_parsed_at":"2023-12-06T17:29:13.236Z","dependency_job_id":"369fec6c-98a0-4479-abfc-ea2112c66656","html_url":"https://github.com/thesurlydev/images","commit_stats":null,"previous_names":["thesurlydev/images"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesurlydev%2Fimages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesurlydev%2Fimages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesurlydev%2Fimages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesurlydev%2Fimages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thesurlydev","download_url":"https://codeload.github.com/thesurlydev/images/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246472582,"owners_count":20783225,"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-13T14:35:58.000Z","updated_at":"2025-03-31T12:43:14.691Z","avatar_url":"https://github.com/thesurlydev.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# images\n\nA distributed asynchronous image processing service.\n\nA detailed [guide](GUIDE.md) is available which walks through the API endpoints and how to use them.\n\n## Highlighted Features\n\n* Selectable storage implementation based on Spring profiles.\n* Batched image processing - perform multiple operations in a single request.\n* Horizontal image processing scalability via \"worker\" nodes.\n* Robust mime type validation via Apache Tika.\n* Authentication via JWT.\n* All components are containerized and can be run locally for a great developer experience.\n* OpenAPI specification and Swagger UI endpoints. See `/api` and `/swagger` respectively.\n\n## Forward Looking Statements\n\n1. **Blob Storage** - The project supports easily adding multiple storage implementations. The current implementation\n   uses the file system for simplicity. A more robust implementation would use a cloud storage provider such as AWS S3\n   for durability and\n   subsequently AWS CloudFront as a CDN.\n2. **Supported Image Types** - Additional image types can be supported by leveraging libraries such as Apache Batik to\n   support SVG.\n3. **Authentication** - The authentication is a simplified version of what should be used in a production environment.\n   Here a JWT token is used to authenticate the user. In a production environment, a more robust solution should be used\n   such as\n   OAuth2.\n4. **API Documentation** - The API should be versioned and documented via OpenAPI. This would ease supporting multiple\n   languages by leveraging\n   code generation for clients. This would also allow for robust contract testing.\n5. **Testing** - The project has a few unit and integration tests but more are warranted before being considered ready\n   for production. Additional unit and integration tests should be added as well as load tests.\n6. **Monitoring** - The project includes basic logging but metrics and tracing should be added for production use.\n\n## Requirements\n\nThese are the requirements for running the project locally:\n\n* Docker Compose\n* curl\n\nIf you use IntelliJ IDEA, you can use the included [test.http](test.http) to exercise endpoints via the internal HTTP\nclient.\n\n## How to build and test\n\nSee: [CONTRIBUTING.md](CONTRIBUTING.md)\n\n## How to run\n\nFrom the root directory, run the following:\n\n```shell    \ndocker-compose up --build\n```\n\nTo stop the containers, run the following:\n\n```shell\ndocker-compose down\n```  \n\n## Architecture\n\n![Component Diagram](etc/assets/arch-diagram.svg)\n\n### Components\n\n- **api** - async REST API server which serves as the entry point for the system. (Spring Boot w/Kotlin coroutines)\n- **blob storage** - storage for images. (File system, S3, etc.)\n- **core** - library which contains shared code between the `api` and `worker`. (Kotlin)\n- **db** - relational database which stores image metadata. (PostgreSQL)\n- **message broker** - messaging broker which is used for communication between the api and worker. (NATS)\n- **worker** - worker which processes image processing jobs. (Spring Boot)\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthesurlydev%2Fimages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthesurlydev%2Fimages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthesurlydev%2Fimages/lists"}