{"id":15323110,"url":"https://github.com/superioz/fancify","last_synced_at":"2025-04-15T02:45:22.353Z","repository":{"id":80549435,"uuid":"162840908","full_name":"Superioz/fancify","owner":"Superioz","description":"Generate fancy names from hashable content.","archived":false,"fork":false,"pushed_at":"2023-05-22T23:43:11.000Z","size":1783,"stargazers_count":7,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T02:45:17.614Z","etag":null,"topics":["flask","restful-api"],"latest_commit_sha":null,"homepage":"https://fancify.superioz.de","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Superioz.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":"2018-12-22T20:30:46.000Z","updated_at":"2021-08-23T19:13:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"b87150c8-c0ac-48a0-9717-4c10bf23606a","html_url":"https://github.com/Superioz/fancify","commit_stats":{"total_commits":20,"total_committers":2,"mean_commits":10.0,"dds":"0.19999999999999996","last_synced_commit":"e7dea3c52dad9ddbabca46707b22e19d540a7547"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Superioz%2Ffancify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Superioz%2Ffancify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Superioz%2Ffancify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Superioz%2Ffancify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Superioz","download_url":"https://codeload.github.com/Superioz/fancify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248997087,"owners_count":21195797,"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":["flask","restful-api"],"created_at":"2024-10-01T09:19:05.930Z","updated_at":"2025-04-15T02:45:22.334Z","avatar_url":"https://github.com/Superioz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fancify :sparkles:\n\nSimple multi-service system to generate a random (and funny) German word from any content.\nFor example literally `content` would be turned into `der heillose Milchsaft`. Nice :thumbsup:\n\nIt works by just putting the input into the seed of a random number generator and then using random numbers to get an adjective and a noun and printing them out together.\n\nFancify supports custom adjectives and nouns via a json file, but the default consists of **~5500** adjectives and nearly **50000** nouns.\n\n## Installation :pray:\n\nThere are multiple ways to setup the system on your machine. Note that every component has its own Docker image, so if you're comfortable with Docker, you can just build it and setup it up yourself.\n\nOtherwise you can use the `docker-compose.yml` to boot it up with `docker-compose up`.\n\nIf that is still not enough for you, you can look into the `/kubernetes` directory of this repo and deploy the components to your Kubernetes Cluster.\n\nNote when doing this: You have to edit the files according to your specific setup. Also you need to put the configs inside the `/kubernetes/dictionary` folder somewhere, either as a ConfigMap or whatever.\nAdditionally (!): The images used in the manifests are pinned to my DockerHub, but you will have to build and deploy the images yourself, as the frontend is hardcoded for my website. That is because the frontend's env variables are set during the build process and not when starting the container - it's just weird, don't ask.\n\n## Usage :joy:\n\nNow that the whole application is running somewhere, we can either access it via the UI or by using the API directly.\n\nThe UI is pretty straightforward. You put your to-be-converted content into the input text above then click the `FANCIFY` Button and see what comes out at the end. You also have the possibility to review the history of your fancified content at the bottom of the page.\n\n![UI](./.github/assets/ui.png)\n\nYou can access the API via the address `http://hostname:8090/fancify` (or whatever address you deployed it to) and make a POST request in which the body contains the content, like so:\n\n```sh\ncurl -X POST -H \"Content-Type: application/json\" -d '{ \"content\": \"yourContentHere\" }' hostname:8090/fancify\n```\n\nAnd you get a response like this:\n\n```json\n{\n    \"result\": \"die klamme Zweigniederlassung\"\n}\n```\n\n## Contribution :raised_hands:\n\nFeel free to create **pull requests** or **issues**.\nDoesn't matter if you just want to add new nouns/adjectives or if you have found a bug.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperioz%2Ffancify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuperioz%2Ffancify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperioz%2Ffancify/lists"}