{"id":15098941,"url":"https://github.com/ydon96/coindex-api","last_synced_at":"2026-02-11T16:34:54.142Z","repository":{"id":227540084,"uuid":"771726737","full_name":"yDon96/CoinDex-API","owner":"yDon96","description":"CoinDex API, your ultimate companion for organizing and categorizing  your coin collection effortlessly! Whether you're a numismatist, a collector, or just someone intrigued by coins, CoinDex API is here  to simplify the process of identifying and categorizing your coins with just a snap.","archived":false,"fork":false,"pushed_at":"2024-05-29T08:15:09.000Z","size":1338,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-07-20T06:41:19.011Z","etag":null,"topics":["chai","docker","eslint","expressjs","husky","mongodb","mongoose","node","prittier","rest-api","tdd","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yDon96.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":"2024-03-13T20:46:46.000Z","updated_at":"2024-05-29T08:15:12.000Z","dependencies_parsed_at":"2024-05-29T09:54:41.797Z","dependency_job_id":null,"html_url":"https://github.com/yDon96/CoinDex-API","commit_stats":null,"previous_names":["ydon96/coindex-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yDon96/CoinDex-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yDon96%2FCoinDex-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yDon96%2FCoinDex-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yDon96%2FCoinDex-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yDon96%2FCoinDex-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yDon96","download_url":"https://codeload.github.com/yDon96/CoinDex-API/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yDon96%2FCoinDex-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271789898,"owners_count":24821466,"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","status":"online","status_checked_at":"2025-08-24T02:00:11.135Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["chai","docker","eslint","expressjs","husky","mongodb","mongoose","node","prittier","rest-api","tdd","typescript"],"created_at":"2024-09-25T17:01:17.422Z","updated_at":"2026-02-11T16:34:54.099Z","avatar_url":"https://github.com/yDon96.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n    CoinDex API 💰\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003cimg src=\"resources/Banner.png\" alt=\"Banner\"\u003e\n\u003c/h1\u003e\n\n\n## Table of Contents\n\n1. [Introduction](#introduction)\n2. [Motivation](#motivation)\n3. [Quick start](#quick-start)\n4. [Documentation](#documentation)\n5. [Docker](#docker)\n6. [Author](#author)\n7. [License](#license)\n---\n## Introduction\n\nWelcome to CoinDex API, your ultimate companion for organizing and categorizing \nyour coin collection effortlessly! \\\nWhether you're a numismatist, a collector, or just someone intrigued by coins, CoinDex API is here \nto simplify the process of identifying and categorizing your coins with just a snap.\n\n---\n## Motivation\n\nWhile manual cataloging and categorizing served as the foundation \nfor coin collection management, this process could be extremely **time-consuming, prone to error \nand difficult to update**.\n\n\n---\n## Quick Start\n\n### 1. Setup the project\n\nOpen your terminal, then run the following command to install dependencies for the project:\n\n```bash\nnpm install\n```\n\n### 2. Set env file\n\nCopy the example [.env file](./.env), and set the needed values:\n```bash\ncp .env .env.dev\n```\n\n\u003e Note: Change 'dev' with 'production' or 'test' for new environment.\n\n### 3. Let's run it!\n\n```bash\nnpm run dev\n```\n\n---\n## Documentation\n\nI utilize Swagger for documenting the API endpoints, \nproviding a clear and interactive way for developers to understand \nthe functionalities and data models of our system.\n\nOnce your project is running, open a web browser and navigate to the Swagger UI URL. This URL is:\n\n```\nhttps://\u003cdomain\u003e/docs\n```\n\n\n---\n## Docker\n\n### 1. Create the image\nOpen a terminal or command prompt, navigate to the directory \ncontaining your Dockerfile, and run the following command:\n```bash\ndocker build -t \u003cimage-name\u003e .    \n```\n\n### 2. Start a new container\n\nOnce the image is built, you can run it using the following command:\n```bash\ndocker run -it -p 3000:3000 -e [env-var-list] \u003cimage-name\u003e       \n```\n\nUse _**'-e'**_ to specify all the required environment variable. (See [here](./.env))\n\n---\n## Author\n\n[![yDon96](https://images.weserv.nl/?url=https://github.com/yDon96.png?v=4\u0026h=60\u0026w=60\u0026fit=cover\u0026mask=circle\u0026maxage=7d)](https://github.com/yDon96)\n\n---\n## 📝 License\n\nCopyright © 2024 [Youssef Donadeo](https://github.com/yDon96)\u003cbr/\u003e\nThis project is [GNUv3]() licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydon96%2Fcoindex-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fydon96%2Fcoindex-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydon96%2Fcoindex-api/lists"}