{"id":22558004,"url":"https://github.com/jd-apprentice/waifuland-api","last_synced_at":"2025-04-10T06:15:02.425Z","repository":{"id":39839148,"uuid":"464322111","full_name":"jd-apprentice/waifuland-api","owner":"jd-apprentice","description":"❤️ Waifuland API - Get random waifus!","archived":false,"fork":false,"pushed_at":"2025-02-28T04:32:09.000Z","size":921,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T07:26:34.697Z","etag":null,"topics":["cloudinary","express","mongodb","multer","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://waifuland.jonathan.com.ar/api","language":"TypeScript","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/jd-apprentice.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":"2022-02-28T03:13:33.000Z","updated_at":"2025-02-28T04:32:13.000Z","dependencies_parsed_at":"2024-01-19T03:40:17.104Z","dependency_job_id":"b7696ee0-c940-43cf-894e-fb37684dd2b5","html_url":"https://github.com/jd-apprentice/waifuland-api","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/jd-apprentice%2Fwaifuland-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jd-apprentice%2Fwaifuland-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jd-apprentice%2Fwaifuland-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jd-apprentice%2Fwaifuland-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jd-apprentice","download_url":"https://codeload.github.com/jd-apprentice/waifuland-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248166859,"owners_count":21058481,"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":["cloudinary","express","mongodb","multer","nodejs","typescript"],"created_at":"2024-12-07T20:10:37.867Z","updated_at":"2025-04-10T06:15:02.381Z","avatar_url":"https://github.com/jd-apprentice.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎲 WAIFULAND-API\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a1af9f77714c498282b102bfb0fd7bf3)](https://app.codacy.com/gh/jd-apprentice/waifuland-api/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n![WaifuLand](https://user-images.githubusercontent.com/68082746/155921172-311bb682-cfed-494f-89c5-371e22ac25a6.gif)\n\nWaifuLand is a REST API that provides information about the anime world. It is a project that is still in development, but it is already functional.\n\n## 🗒 About the project\n\n- The project is a REST API which gives random waifu images, they are uploaded to cloudinary and their public url is stored in mongodb\n- Learning throught documentation and breaking things\n- Expect many bugs and errors in the code\n- You are free to collaborate with the project or use it as you wish\n\n## 🚧 Routes\n\n- `GET` Grab a random image `api/images`\n- `GET` Grab an array of random images `api/images?size=\u003cSize\u003e`\n- `GET` Grab a random image `api/images?tag_id=\u003ctag_id\u003e`\n\n## ✍️ Examples\n\n```bash\n$ curl https://waifuland.jonathan.com.ar/api/images -H \"Accept: application/json\"\n$ curl https://waifuland.jonathan.com.ar/api/images\\?size\\=5\\\u0026tag_id\\=1 -H \"Accept: application/json\"\n```\n\n\n## 📚 Stack\n\n- Bunjs\n- Express\n- Typescript\n- Multer\n- Cloudinary\n- Mongodb\n- Mongoose\n- Rollbar\n- Husky\n\n## 🏗️ Build the project locally\n\n```\nFill the fields in the .env.example\n\n# App port\nPORT=\n\n# Your mongodb uri\nDB_HOST=\n\n# Your secret hash for signing petitions\nTOKEN=\n\n# Your cloudinary information\nCLOUD_NAME=\nCLOUD_API_KEY=\nCLOUD_SECRET=\nCLOUDINARY_URL=\n\n# Rollbar information\nROLLBAR_TOKEN=\nROLLBAR_ENVIRONMENT=\n\n\u003e\u003e cp .env.example .env\n\n\u003e\u003e bun install\n\n\u003e\u003e bun run dev\n```\n\n## 🧱 Structure\n\n- User enters the page\n  ![Login](https://user-images.githubusercontent.com/68082746/164032923-64c5d286-e232-478f-b121-39d28b71b416.png)\n- Once user is logged into the page\n  ![Token](https://user-images.githubusercontent.com/68082746/164033037-6191489e-3561-46b3-a0c4-7324faf9abb7.png)\n\n## 📁 Folders\n\n```\n📦src\n┣ 📂app\n┣ 📂common\n┣ 📂image\n┗ 📂user\n┃ ┣ 📂dto\n┃ ┣ 📂interfaces\n┃ ┃ ┗ 📜user-interface.ts\n┃ ┣ 📂schema\n┃ ┃ ┗ 📜user-schema.ts\n┃ ┣ 📜user-controller.ts\n┃ ┣ 📜user-middleware.ts\n┃ ┣ 📜user-repository.ts\n┃ ┣ 📜user-routes.ts\n┃ ┗ 📜user-service.ts\n```\n\n## 📝 License\n\nThis project is under the MIT license. See the [LICENSE](./LICENSE) for more information.\n\n## 🤝 Contribute\n\n- For more information, check the [CONTRIBUTE](./CONTRIBUTE.md) file\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://jonathan.com.ar/es\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/68082746?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJonathan Dyallo\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/jd-apprentice/waifuland-api/commits?author=jd-apprentice\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/jd-apprentice/waifuland-api/commits?author=jd-apprentice\" title=\"Tests\"\u003e⚠️\u003c/a\u003e \u003ca href=\"https://github.com/jd-apprentice/waifuland-api/commits?author=jd-apprentice\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#maintenance-jd-apprentice\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjd-apprentice%2Fwaifuland-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjd-apprentice%2Fwaifuland-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjd-apprentice%2Fwaifuland-api/lists"}