{"id":20050495,"url":"https://github.com/thecodeteam/mosaicme","last_synced_at":"2025-10-17T17:56:58.467Z","repository":{"id":28943622,"uuid":"32469526","full_name":"thecodeteam/mosaicme","owner":"thecodeteam","description":"Micro service application that retrieves images from Twitter feeds, stores and process them to build a mosaic based on a selected picture.","archived":false,"fork":false,"pushed_at":"2016-11-01T18:20:05.000Z","size":36573,"stargazers_count":15,"open_issues_count":11,"forks_count":16,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-04-08T22:01:33.047Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/thecodeteam.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}},"created_at":"2015-03-18T16:09:39.000Z","updated_at":"2020-01-18T18:58:38.000Z","dependencies_parsed_at":"2022-08-28T07:51:39.499Z","dependency_job_id":null,"html_url":"https://github.com/thecodeteam/mosaicme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodeteam%2Fmosaicme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodeteam%2Fmosaicme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodeteam%2Fmosaicme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecodeteam%2Fmosaicme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thecodeteam","download_url":"https://codeload.github.com/thecodeteam/mosaicme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252489011,"owners_count":21756247,"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-11-13T11:57:37.025Z","updated_at":"2025-10-17T17:56:58.374Z","avatar_url":"https://github.com/thecodeteam.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MosaicMe\n\n## Introduction\n\nMosaicMe is a [Microservice](http://en.wikipedia.org/wiki/Microservices \"Microservices\") application that retrieves images from selected Twitter feeds, stores them on an [object store](http://en.wikipedia.org/wiki/Object_storage \"Object Store\"), and then it process them to build a mosaic based on a selected set of pictures.\n\nThe MosaicMe application is a demo application to showcase how to design, build, and deploy a microservices application. We have followed the best practices shared by the [12 Factor App](http://12factor.net/) manifest and  DevOps best practices to showcase how to do Continuous Integration (CI) and Continuous Deployment (CD) to automate the deployment of the application.\n\n\n## How does it work?\n\nMosaicMe is composed of multiple tiers. The following figure is a high level architecture diagram of the different services that take part in the process.\n\n![MosaicMe architecture](images/mosaicme-architecture.png)\n\nThe whole process is triggered by a user sending a tweet with the hashtag `#mosaicme` and a picture like the following one.\n\n![Tweet Mosaic request](images/tweet-mosaic-request.png)\n\nRight after, the **Listener** service, which is connected to the **Twitter Streaming API** and listening to the `#mosaicme` feed, receives the tweet and obtains  information about the requester (name and Twitter handler) and the image URL. Then, this information is passed to the **Engine** service via messaging queues.\n\nThe **Engine** needs a database of raw images to build mosaics. This database is populated by the **Uploader**, which receives images from a different instance of the **Listener** that is constantly receiving tweets from popular hashtags.\n\nOnce the **Engine** has enough raw images to operate, it takes over and builds the mosaic using [Metapixel](https://www.complang.tuwien.ac.at/schani/metapixel/). After a few minutes, once the mosaic is done, the Engine uploads the image to the object store (Swift, S3), attaching the requester information as object metadata. Afterwards, it notifies the **Publisher** and **Cacher** services.\n\nThe **Publisher** service sends a tweet via the **Twitter REST API** mentioning the user that requested the mosaic with the mosaic thumbnail attached and a link to the MosaicMe website to see the full-resolution mosaic.\n\n![Tweet Mosaic result](images/tweet-mosaic-result.png)\n\nThe **Cacher** service, on the other hand, updates the cache (Redis) with the latest mosaic metadata.\n\nFinally, when the user checks the tweet and clicks on the link, it is redirected to the MosaicMe **Website**. The website obtains the mosaics metadata from the cache and the user browser downloads the mosaics directly from the object store.\n\n\n## How can I run it?\n\nCheck out the [Deployment Guide](DEPLOYMENT.md) for information about deploying MosaicMe using the Docker images available.\n\n\n## Contributing\n\nDid you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/emccode/mosaicme/issues) to let us know. Or make directly a [pull request](https://github.com/emccode/mosaicme/pulls).\n\n\n## Licensing\n\nMosaicMe is licensed under the [MIT](http://opensource.org/licenses/MIT \"The MIT License (MIT)\") license. Check out the [LICENSE](https://github.com/emccode/mosaicme/blob/master/LICENSE) file for the latest licensing information.\n\n\n## Support\n\nIf you have questions relating to the project, please either post [GitHub Issues](https://github.com/emccode/mesos-module-dvdi/issues), join our Slack channel available by signup through [community.emc.com](https://community.emccode.com) and post questions into `#mosaicme`, or reach out to the maintainers directly.  The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecodeteam%2Fmosaicme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecodeteam%2Fmosaicme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecodeteam%2Fmosaicme/lists"}