{"id":27297963,"url":"https://github.com/hackmcgill/hackerapi-client-ts","last_synced_at":"2025-04-12T00:25:09.519Z","repository":{"id":57114838,"uuid":"169179758","full_name":"hackmcgill/hackerAPI-client-ts","owner":"hackmcgill","description":"Typescript client for hackerAPI.","archived":false,"fork":false,"pushed_at":"2019-06-05T22:27:40.000Z","size":56,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T16:36:27.659Z","etag":null,"topics":["api","client","hackathon","registration","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hackmcgill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-05T02:16:38.000Z","updated_at":"2019-02-07T02:30:51.000Z","dependencies_parsed_at":"2022-08-22T10:10:53.194Z","dependency_job_id":null,"html_url":"https://github.com/hackmcgill/hackerAPI-client-ts","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmcgill%2FhackerAPI-client-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmcgill%2FhackerAPI-client-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmcgill%2FhackerAPI-client-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmcgill%2FhackerAPI-client-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackmcgill","download_url":"https://codeload.github.com/hackmcgill/hackerAPI-client-ts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248498805,"owners_count":21114193,"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","client","hackathon","registration","typescript"],"created_at":"2025-04-12T00:25:07.243Z","updated_at":"2025-04-12T00:25:07.907Z","avatar_url":"https://github.com/hackmcgill.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hackerAPI-client-ts\n\nTypescript client for [hackerAPI.](https://github.com/hackmcgill/hackerAPI)\n\n## Installation\n\nTo install, use npm:\n\n```bash\nnpm install @hackmcgill/hackerapi-client-ts\n```\n\n## Usage\n\nAt the entry-point of your code, you must provide the endpoint of the API:\n\n```typescript\nimport { api as API } from '@hackmcgill/hackerapi-client-ts';\nAPI.setURL('https://api.mchacks.ca');\n```\n\nAfterwards, you can use whichever resource you would like. For example, you can create an Account as such:\n\n```typescript\nimport { Account } from '@hackmcgill/hackerapi-client-ts';\nAccount.create({\n  accountType: UserType.HACKER;\n  confirmed: true;\n  firstName: 'John';\n  lastName: 'Doe';\n  email: 'john.doe@mchacks.ca';\n  dietaryRestrictions: ['Halal', 'Vegetarian'];\n  shirtSize: ShirtSize.XL;\n  password: 'hunter2';\n  phoneNumber: '1234567889';\n  birthDate: '2008-09-15T15:53:00';\n  pronoun: 'He / him';\n  id: '';\n});\n```\n\nDocumentation on the different routes can be [found here.](https://docs.mchacks.ca/api/)\n\n## Example usage\n\nUsage in a real-life repository can be [found here.](https://github.com/hackmcgill/hackerAPI-frontend)\n\n## Questions\n\nIf you have questions about how to use this, shoot an email to \u003cdevops@mchacks.ca\u003e, or create an [Issue.](https://github.com/hackmcgill/hackerAPI-client-ts/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmcgill%2Fhackerapi-client-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackmcgill%2Fhackerapi-client-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmcgill%2Fhackerapi-client-ts/lists"}