{"id":25131840,"url":"https://github.com/csgn/kliq","last_synced_at":"2025-04-03T00:11:24.242Z","repository":{"id":276326333,"uuid":"926529254","full_name":"csgn/kliq","owner":"csgn","description":"Clickstream service and sdk","archived":false,"fork":false,"pushed_at":"2025-02-07T14:36:26.000Z","size":86,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T15:32:00.718Z","etag":null,"topics":["clickstream"],"latest_commit_sha":null,"homepage":"","language":"Go","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/csgn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2025-02-03T12:22:06.000Z","updated_at":"2025-02-07T14:36:30.000Z","dependencies_parsed_at":"2025-02-07T15:33:54.009Z","dependency_job_id":"511a9ad4-faa9-4798-9d04-0e5caaeb2957","html_url":"https://github.com/csgn/kliq","commit_stats":null,"previous_names":["csgn/kliq"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csgn%2Fkliq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csgn%2Fkliq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csgn%2Fkliq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csgn%2Fkliq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csgn","download_url":"https://codeload.github.com/csgn/kliq/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246911475,"owners_count":20853657,"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":["clickstream"],"created_at":"2025-02-08T14:15:37.398Z","updated_at":"2025-04-03T00:11:24.219Z","avatar_url":"https://github.com/csgn.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kliq\n\n# Overview\nA service will collect user events and store the raw data on the \n```Apache Hadoop``` cluster, and **internal consumers** can access the cluster via\n```Apache Spark```, ```Presto``` etc. to read processed data in order to use\nit in their own business purposes.\n\n# Purpose of Service\nWe are collecting user events for the reasons listed below:\n\n1. Recommend better **product** or **content** to users based on their \nhistorical behaviour.\n2. Creating **advertising campaigns** based on users' behaviour.\n3. Understand how **different page layouts** or **contents** affect users'\nbehaviour.\n\n# Architecture\n![kliq_diagram](/docs/resources/kliq-diagram.png)\n\n[Edit diagram](/docs/kliq-diagram.mmd)\n\n# Usage\n\n## Run the service\n```sh\n$ ENV=dev make up # will use \"docker/env/dev\" environment file\n```\n\n## Down the service\n```sh\n$ ENV=dev make down \n```\n\n## Stop the service\n```sh\n$ ENV=dev make stop\n```\n\n## Show the summary\n```sh\n$ ENV=dev make summary\n```\n\n# Modules\n| Service                               | Description                                                                        |                                              \n| ------------------------------------- | ---------------------------------------------------------------------------------- |\n| [kliq-collect](/docs/kliq-collect.md) | Exposes an HTTP server to collect user events and sent them into the kafka topic.  |\n| [kliq-kafka](/docs/kliq-kafka.md)     | A message broker for events.                                                       |\n| [kliq-stream](/docs/kliq-stream.md)   | Stream process for ingesting.                                                      |\n| [kliq-hadoop](/docs/kliq-hadoop.md)   | Events storage.                                                                    |\n| [kliq-batch](/docs/kliq-batch.md)     | Reorganize the raw events.                                                         |\n\n\n# License\n```\nMIT License\n\nCopyright (c) 2024 Sergen Çepoğlu\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsgn%2Fkliq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsgn%2Fkliq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsgn%2Fkliq/lists"}