{"id":13591982,"url":"https://github.com/frncsdrk/avatar","last_synced_at":"2025-04-06T12:08:35.554Z","repository":{"id":42993029,"uuid":"131040104","full_name":"frncsdrk/avatar","owner":"frncsdrk","description":"Self-hosted service for creating random avatars","archived":false,"fork":false,"pushed_at":"2024-10-23T23:40:49.000Z","size":1605,"stargazers_count":109,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-24T13:14:39.577Z","etag":null,"topics":["avatar","expressjs","generator","nodejs","random","self-hosted","service"],"latest_commit_sha":null,"homepage":"https://frncsdrk.github.io/avatar","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/frncsdrk.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":"2018-04-25T17:18:17.000Z","updated_at":"2024-10-23T23:40:42.000Z","dependencies_parsed_at":"2024-01-14T04:09:13.057Z","dependency_job_id":"b03d0ec3-1a5e-4d54-b188-b6b0f8cb79f6","html_url":"https://github.com/frncsdrk/avatar","commit_stats":null,"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frncsdrk%2Favatar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frncsdrk%2Favatar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frncsdrk%2Favatar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frncsdrk%2Favatar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frncsdrk","download_url":"https://codeload.github.com/frncsdrk/avatar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247478323,"owners_count":20945266,"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":["avatar","expressjs","generator","nodejs","random","self-hosted","service"],"created_at":"2024-08-01T16:01:04.442Z","updated_at":"2025-04-06T12:08:35.532Z","avatar_url":"https://github.com/frncsdrk.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# avatar\n\n[![build](https://github.com/frncsdrk/avatar/actions/workflows/build.yml/badge.svg)](https://github.com/frncsdrk/avatar/actions/workflows/build.yml)\n\nSelf-hosted service for creating random avatars\n\nInspired by github default avatars\n\n## Examples\n\n### Random\n\n![random squares](./img/random-0.png \"squares\")\n![random circles](./img/random-1.png \"circles\")\n![random triangles](./img/random-2.png \"triangles\")\n\n### Initials\n\n![initials AV](./img/initials-0.png \"initials\")\n\n## Usage\n\nDefault **Port**: `9000`\n\n### Download\n\nEither download a release from the [Releases page](https://github.com/frncsdrk/avatar/tags) or clone the repo.\nThen follow the steps under [Development Setup](https://github.com/frncsdrk/avatar#setup).\n\n### Docker\n\nThere is a container image available on [Docker Hub](https://hub.docker.com/r/frncsdrk/avatar)\nand there is a Docker-Compose file in the repo.\nBoth are provided for convenience and as a starting point for a production setup.\n\n```\ndocker|podman run -p 9000:9000/tcp docker.io/frncsdrk/avatar\n```\n\n### Configuration\n\nYou can put config files into `./config/`. See [file load order](https://github.com/node-config/node-config/wiki/Configuration-Files#file-load-order) for configuration names and there priority.\n\n**Mount configuration into container**\n\n*Generally mounting a custom configuration shouldn't be necessary, except if you want to set a custom port*\n\nUsing another name than `prod.yml` will lead to a warning when using the container image from this repository.\nThe warning is irrelevant as long as you follow the configuration naming conventions.\n\n```\ndocker|podman run -p \u003ccustom port\u003e:\u003ccustom port\u003e/tcp -v ./vol:/app/config docker.io/frncsdrk/avatar\n```\n\n## API\n\nSee [API Docs](https://frncsdrk.github.io/avatar)\n\n## Logs\n\nThe service uses a preconfigured log directory and logs into a combined log with all messages and an error log.\nFor the development environment the default directory is `./log` and for production it is `/var/log/avatar`.\nAdditionally, if the service is not running in production mode all messages get logged to the console.\n\n## Development\n\n### Setup\n\n#### Prerequisites\n\n- Node.js installation\n- Libraries for image editing\n- apiDoc installation, if editing docs\n\n#### Steps\n\n- Run `brew install node` or similar to install Node.js\n- Run `brew install pkg-config cairo pango libpng jpeg giflib librsvg` or similar to install libraries for image editing\n- Run `npm install -g apidoc` to install apiDoc globally\n\n### Usage\n\n- Run `npm start` to start service\n- Run `npm run dev` to start service with nodemon\n- Run `npm run generate:docs` to generate API docs from source code\n\n## Contributions\n\nSee [CONTRIBUTING](https://github.com/frncsdrk/avatar/blob/main/CONTRIBUTING.md)\n\n## Credits\n\nSee [CREDITS](https://github.com/frncsdrk/avatar/blob/main/CREDITS)\n\n## License\n\n[MIT](https://github.com/frncsdrk/avatar/blob/main/LICENSE) (c) 2018 - 2025 frncsdrk and contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrncsdrk%2Favatar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrncsdrk%2Favatar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrncsdrk%2Favatar/lists"}