{"id":31921186,"url":"https://github.com/themetalfleece/nodejs-typescript-template","last_synced_at":"2025-10-29T22:14:26.369Z","repository":{"id":43704444,"uuid":"298342645","full_name":"themetalfleece/nodejs-typescript-template","owner":"themetalfleece","description":"A template for a Node.js project using Typescript, ESLint, Prettier. It's Docker-ready. Everything is configured with the appropriate scripts and README. An MIT license is set.","archived":false,"fork":false,"pushed_at":"2025-10-01T00:19:31.000Z","size":422,"stargazers_count":68,"open_issues_count":0,"forks_count":27,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-01T02:36:57.000Z","etag":null,"topics":["docker","nodejs","typescript"],"latest_commit_sha":null,"homepage":"","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/themetalfleece.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-09-24T17:01:44.000Z","updated_at":"2025-10-01T00:19:34.000Z","dependencies_parsed_at":"2024-08-24T01:27:23.600Z","dependency_job_id":"b49e40d6-f0be-421a-b0b3-41234c511ad7","html_url":"https://github.com/themetalfleece/nodejs-typescript-template","commit_stats":null,"previous_names":[],"tags_count":548,"template":true,"template_full_name":null,"purl":"pkg:github/themetalfleece/nodejs-typescript-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/themetalfleece%2Fnodejs-typescript-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/themetalfleece%2Fnodejs-typescript-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/themetalfleece%2Fnodejs-typescript-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/themetalfleece%2Fnodejs-typescript-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/themetalfleece","download_url":"https://codeload.github.com/themetalfleece/nodejs-typescript-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/themetalfleece%2Fnodejs-typescript-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017154,"owners_count":26085983,"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-10-13T02:00:06.723Z","response_time":61,"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":["docker","nodejs","typescript"],"created_at":"2025-10-13T22:31:43.672Z","updated_at":"2025-10-13T22:32:28.581Z","avatar_url":"https://github.com/themetalfleece.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#### This project was created using [themetalfleece/nodejs-typescript-template](https://github.com/themetalfleece/nodejs-typescript-template)\n\n# This template gets updated daily so the latest dependencies are always used!\n\n## What to do after using this template\n\n1. Edit `package.json` to set the project name, version, description, and author.\n2. Edit the `LICENSE` file to use your name in the Copyright section.\n3. Edit the `.prettierrc.json` file with your preferred values.\n4. Remove the `.github/workflows/upgrade-dependencies.yml` files, since it contains the workflow to upgrade all dependencies on a daily basis.\n   * In case you would like to keep it, remove lines 7, 30, 32 from it. Also, change the git user name in line 28.\n5. Delete this section from the `README.md` file.\n6. Start coding by editing the `src/app.ts` file!\n\n## Install\n\n1. Install [node.js](https://nodejs.org/en/download/), [yarn](https://yarnpkg.com/getting-started/install) (or use npm).\n2. Clone this repository, and using a terminal navigate to its directory.\n3. Run `yarn` or `npm install` to install the dependencies.\n\n## Build \u0026 Run\n\n1. Copy the contents of the `.env.example` file to a `.env` next to it, and edit it with your values.\n2. Run `yarn build` or `npm build` to build the files.\n3. Run `yarn start` or `npm start` to start the application.\n\n-   You can run `yarn dev` or `npm dev` to combine the 2 steps above, while listening to changes and restarting automatically.\n\n## Run with Docker\n\n1. Build:\n\n    ```\n    docker build -t my-app .\n    ```\n\n    Replacing `my-app` with the image name.\n\n2. Run\n    ```\n    docker run -d -p 3000:3000 my-app\n    ```\n    Replacing `my-app` with the image name, and `3000:3000` with the `host:container` ports to publish.\n\n## Developing\n\n### Visual Studio Code\n\n-   Installing the Eslint (`dbaeumer.vscode-eslint`) and Prettier - Code formatter (`esbenp.prettier-vscode`) extensions is recommended.\n\n## Linting \u0026 Formatting\n\n-   Run `yarn lint` or `npm lint` to lint the code.\n-   Run `yarn format` or `npm format` to format the code.\n\n## Testing\n\nCheck the placeholder test examples to get started : \n\n- `/src/app.ts` that provide a function `sum` \n- `/test/app.spec.ts` who test the `sum` function \n\nThis files are just an example, feel free to remove it\n\n-   Run `yarn test` or `npm test` to execute all tests.\n-   Run `yarn test:watch` or `npm test:watch` to run tests in watch (loop) mode.\n-   Run `yarn test:coverage` or `npm test:coverage` to see the tests coverage report.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthemetalfleece%2Fnodejs-typescript-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthemetalfleece%2Fnodejs-typescript-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthemetalfleece%2Fnodejs-typescript-template/lists"}