{"id":19465834,"url":"https://github.com/mymicds/mymicds-v2","last_synced_at":"2025-09-10T18:44:59.993Z","repository":{"id":9536704,"uuid":"51406587","full_name":"MyMICDS/MyMICDS-v2","owner":"MyMICDS","description":"Back-end REST API for MyMICDS.net","archived":false,"fork":false,"pushed_at":"2023-09-21T06:16:23.000Z","size":20550,"stargazers_count":8,"open_issues_count":65,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-21T08:05:45.015Z","etag":null,"topics":["express","micds","mymicds","nodejs","rest-api"],"latest_commit_sha":null,"homepage":"https://mymicds.net","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MyMICDS.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":"2016-02-09T22:51:34.000Z","updated_at":"2023-09-19T08:24:00.000Z","dependencies_parsed_at":"2024-11-10T18:28:02.276Z","dependency_job_id":"1877e607-a26d-439b-918b-909338e71a54","html_url":"https://github.com/MyMICDS/MyMICDS-v2","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/MyMICDS%2FMyMICDS-v2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyMICDS%2FMyMICDS-v2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyMICDS%2FMyMICDS-v2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MyMICDS%2FMyMICDS-v2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MyMICDS","download_url":"https://codeload.github.com/MyMICDS/MyMICDS-v2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250790196,"owners_count":21487765,"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":["express","micds","mymicds","nodejs","rest-api"],"created_at":"2024-11-10T18:23:59.328Z","updated_at":"2025-04-25T09:32:10.576Z","avatar_url":"https://github.com/MyMICDS.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MyMICDS-v2\nMyMICDS.net for all of your MyMICDS.needs\n\n## Setup\n\n### Dependencies\nTo start development on MyMICDS-v2, first run `npm install` in the main project directory.\nThis will install all the runtime dependencies (including TypeScript) as well as TypeDoc, TSLint, and all the other development dependencies.\n\n### Configuration\nA local config file is required on every machine you develop on. This stores sensitive information such as database credentials and API keys.\nCopy `src/libs/config.example.ts` into a new file called `config.ts` with the proper information filled out as described in the example.\nThis file is included in `.gitignore`, so you don't have to worry about accidentally committing the credentials.\n\n### Usage\nTo start the server for development, run `npm start`. In a production environment, run `npm run prod`. \n\n#### Tasks Server\nTo start the tasks server, run `npm run tasks`.\n\n#### For Development\nIf you would like the server to restart on file changes, install [`nodemon`](https://nodemon.io/) and simply run `nodemon` in the project root.\n\n### Documentation\nRun `npm run docs` to build documentation. TypeDoc will generate documentation based on comments and type structures and dump it into the `/docs/` folder.\nThis creates static HTML files, so you'll have to open them manually in your browser.\n\n### Testing\nRun `npm test` to do a compilation check on all source files and run the API tests.\nSimilar to `src/libs/config.ts`, the tests require a `test/config.ts` that needs to be filled out.\n\n**Note:** When adding new routes to the API, contributors should always add a corresponding test,\nunless there are factors (performance, authentication, etc) that would make it unreasonable to run the test quickly on a CI server.\n\n\n## Other Repositories\n\n### [MyMICDS-v2-Angular](https://github.com/MyMICDS/MyMICDS-v2-Angular)\nThe Angular front-end for MyMICDS.\n\n### [MyMICDS-SDK](https://github.com/MyMICDS/MyMICDS-SDK)\nThe official TypeScript client for connecting to MyMICDS. Automatically handles API requests using RxJS.\n\n### [MyMICDS-WatchFace](https://github.com/MyMICDS/MyMICDS-WatchFace)\nA Wear OS watch face featuring MyMICDS integration.\n\n\n## Contact\nWanna become a developer on the MyMICDS.net team? Shoot us an email at [support@mymicds.net](mailto:support@mymicds.net)!\nWe accept anyone and everyone, so don't be shy!\n\nFor any other questions, comments, concerns, or suggestions, you can also contact support@mymicds.net.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmymicds%2Fmymicds-v2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmymicds%2Fmymicds-v2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmymicds%2Fmymicds-v2/lists"}