{"id":21598893,"url":"https://github.com/prettifystudio/avatary","last_synced_at":"2025-04-11T01:04:52.724Z","repository":{"id":46970816,"uuid":"405020394","full_name":"prettifystudio/avatary","owner":"prettifystudio","description":"Generate Avatars using Initials, Bears or Kittens (coming soon)","archived":false,"fork":false,"pushed_at":"2022-02-16T23:02:15.000Z","size":692,"stargazers_count":39,"open_issues_count":0,"forks_count":11,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-11T01:04:42.932Z","etag":null,"topics":["api","avatar-generator","avatar-placeholder","laravel","laravel-framework"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/prettifystudio.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":"2021-09-10T09:06:50.000Z","updated_at":"2025-01-04T02:38:51.000Z","dependencies_parsed_at":"2022-09-24T19:40:42.592Z","dependency_job_id":null,"html_url":"https://github.com/prettifystudio/avatary","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/prettifystudio%2Favatary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prettifystudio%2Favatary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prettifystudio%2Favatary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prettifystudio%2Favatary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prettifystudio","download_url":"https://codeload.github.com/prettifystudio/avatary/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322597,"owners_count":21084336,"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":["api","avatar-generator","avatar-placeholder","laravel","laravel-framework"],"created_at":"2024-11-24T18:13:28.871Z","updated_at":"2025-04-11T01:04:52.700Z","avatar_url":"https://github.com/prettifystudio.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n*** Thanks for checking out the Best-README-Template. If you have a suggestion\n*** that would make this better, please fork the repo and create a pull request\n*** or simply open an issue with the tag \"enhancement\".\n*** Thanks again! Now go create something AMAZING! :D\n***HelloWorld\n--\u003e\n\n\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ch2 align=\"center\"\u003eAvatary\u003c/h2\u003e\n\n  \u003cp align=\"center\"\u003e\n    Simple avatar generator\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/prettifystudio/avatary\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://avatary.prettify.studio/\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/prettifystudio/avatary/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/prettifystudio/avatary/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails open=\"open\"\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nIt's just a simple project to generate avatars using names. For the moment it supports only english and arabic names.\n\n\n### Built With\n\nThis project is made with the awesome frameworks/packages \n* [Laravel](https://laravel.com)\n* [TailwindCSS](https://tailwindcss.com/)\n* [Intervention Images](http://image.intervention.io/)\n\nAnd this awesome Readme is made possible with :\n* [Best README Template](https://github.com/othneildrew/Best-README-Template)\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nThis is an example of how you may give instructions on setting up your project locally.\nTo get a local copy up and running follow these simple example steps.\n\n### Prerequisites\n\nSince Avatary is built using Laravel 8, so the prerequisites are the same as the framework\n\n* PHP \u003e= 8.0\n* BCMath PHP Extension\n* Ctype PHP Extension\n* Fileinfo PHP Extension\n* JSON PHP Extension\n* Mbstring PHP Extension\n* OpenSSL PHP Extension\n* PDO PHP Extension\n* Tokenizer PHP Extension\n* XML PHP Extension\n* GD PHP Extension\n\n\n\n### Installation\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/prettifystudio/avatary.git\n   ```\n2. Install Composer packages\n   ```sh\n   composer install\n   ```\n3. Copy the environment file \u0026 edit it accordingly\n   ```sh\n   cp .env.example .env\n   ```\n\n4. Generate application key\n   ```sh\n   php artisan key:generate\n   ```\n\n5. Linking Storage folder to public\n   ```sh\n   php artisan storage:link\n   ```\n6. Serve the application\n   ```sh\n   php artisan serve\n   ```\n\n\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\nUsing the API is simple, all you have to do is hit the [Initials API](https://avatary.prettify.studio/api/initials).\nWithout any parameter, the endpoint will generate an image with random background color.\n\nBut you can customize it as you need.\n\n### Name \nIf you want to customize the name, you can hit the endpoint with the query param ```name``` .\n\nThe default value is \"John Doe\" \n```\nGET https://avatary.prettify.studio/api/initials?name=Koussay Fridhi\n```\n\n### Background Color\nBackground colors, are generated randomly, but you can speacify it as follows:\n\n_The Background color must be in hexadecimal form, otherwise the system will throw an exception_\n\n```\nGET https://avatary.prettify.studio/api/initials?bgcolor=f43f43\n```\n\n### Size\nThe default size of the generated image is 260px, but you can specify a custom size\n\n```\nGET https://avatary.prettify.studio/api/initials?size=75\n```\nThis will generate a 75*75 px image. \nGenerally you may want to use a smaller size so the request is handled quickly.\n\n\n### Text Color\nYou may want also to specify the text color, inside the image.\n\nThe default value is \u003cpre\u003e#fafafa\u003c/pre\u003e \n\n\n_The text color must be in hexadecimal form, otherwise the system will throw an exception_\n\n\n```\nGET https://avatary.prettify.studio/api/initials?color=fafafa\n```\n\n### Shape\nThe API will generate 2 shapes, a circle or a square. The default one is the circle, but you can get a square shape\n```\nGET https://avatary.prettify.studio/api/initials?shape=square\n```\n\n### Full request \n\n```\nGET https://avatary.prettify.studio/api/initials?name=Koussay%20Fridhi\u0026bgcolor=f44336\u0026shape=circle\u0026color=fafafa\u0026size=250\n```\nThis request will generate the following image\n\n\u003csection align=\"center\"\u003e\n    \u003cimg src=\"https://avatary.prettify.studio/api/initials?name=Koussay%20Fridhi\u0026bgcolor=f44336\u0026shape=circle\u0026color=fafafa\u0026size=120\"\u003e\n\u003c/section\u003e\n\nYou can use any param you want, for example you want only the name and the size,\n\n```\nGET https://avatary.prettify.studio/api/initials?name=Koussay%20Fridhi\u0026size=125\n```\n\n\n\n## Testing\n\nThis application is using PestPHP for testing. In order to run the test suite\n```bash\n./vendor/bin/pest\n```\n\n\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nSee the [open issues](https://github.com/prettifystudio/avatary/issues) for a list of proposed features (and known issues).\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nYour Name - [@PrettifyStudio](https://twitter.com/prettifystudio) - hey@prettify.studio\n\nProject Link: [https://github.com/prettifystudio/avatary](https://github.com/prettifystudio/avatary)\n\n\n\n\n\n\n\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/prettifystudio/avatary.svg?style=for-the-badge\n[contributors-url]: https://github.com/prettifystudio/avatary/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/prettifystudio/avatary.svg?style=for-the-badge\n[forks-url]: https://github.com/prettifystudio/avatary/network/members\n[stars-shield]: https://img.shields.io/github/stars/prettifystudio/avatary.svg?style=for-the-badge\n[stars-url]: https://github.com/prettifystudio/avatary/stargazers\n[issues-shield]: https://img.shields.io/github/issues/prettifystudio/avatary.svg?style=for-the-badge\n[issues-url]: https://github.com/prettifystudio/avatary/issues\n[license-shield]: https://img.shields.io/github/license/prettifystudio/avatary.svg?style=for-the-badge\n[license-url]: https://github.com/prettifystudio/avatary/blob/master/LICENSE.txt\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://linkedin.com/in/othneildrew\n[product-screenshot]: images/screenshot.png\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprettifystudio%2Favatary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprettifystudio%2Favatary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprettifystudio%2Favatary/lists"}