{"id":20407196,"url":"https://github.com/lissone/node-api-template","last_synced_at":"2025-04-12T15:12:03.640Z","repository":{"id":52214046,"uuid":"352831515","full_name":"Lissone/node-api-template","owner":"Lissone","description":"Template made in Typescript with Express and structured with an architecture based on clean and DDD.","archived":false,"fork":false,"pushed_at":"2024-09-15T15:42:45.000Z","size":570,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T15:11:55.751Z","etag":null,"topics":["commitlint","docker-compose","eslint","express","husky","nodejs","postgresql","typeorm","typescript","yup"],"latest_commit_sha":null,"homepage":"","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/Lissone.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-30T01:17:12.000Z","updated_at":"2024-09-15T15:39:19.000Z","dependencies_parsed_at":"2024-09-15T16:21:47.738Z","dependency_job_id":"1ef44f93-5af0-4934-a7c4-cadb12d9467e","html_url":"https://github.com/Lissone/node-api-template","commit_stats":null,"previous_names":["lissone/node-api-template","lissone/simple-node-api-template"],"tags_count":5,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissone%2Fnode-api-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissone%2Fnode-api-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissone%2Fnode-api-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissone%2Fnode-api-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Lissone","download_url":"https://codeload.github.com/Lissone/node-api-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586244,"owners_count":21128998,"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":["commitlint","docker-compose","eslint","express","husky","nodejs","postgresql","typeorm","typescript","yup"],"created_at":"2024-11-15T05:22:02.257Z","updated_at":"2025-04-12T15:12:03.589Z","avatar_url":"https://github.com/Lissone.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  Node Express API Template\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#description\"\u003eDescription\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#requirements\"\u003eRequirements\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#technologies\"\u003eTechnologies\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#endpoints\"\u003eEndpoints\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/static/v1?label=license\u0026message=MIT\" alt=\"License\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/repo-size/Lissone/node-api-template\" alt=\"Repo size\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/languages/top/Lissone/node-api-template\" alt=\"Top lang\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/stars/Lissone/node-api-template\" alt=\"Stars repo\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/forks/Lissone/node-api-template\" alt=\"Forks repo\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/issues-pr/Lissone/node-api-template\" alt=\"Pull requests\" \u003e\n  \u003cimg src=\"https://img.shields.io/github/last-commit/Lissone/node-api-template\" alt=\"Last commit\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Lissone/node-api-template/issues\"\u003eReport bug\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/Lissone/node-api-template/issues\"\u003eRequest feature\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n## Description\n\nTemplate made in Typescript with Express and structured with an architecture based on clean and DDD, to facilitate the creation of new projects and developer productivity, which can be created from this one.\n\nAlready configured with Typescript, ORM, Linter and Husky, with a pre-built CRUD and endpoints listed in the documentation.\n\n### Requirements\n\n- [Nodejs](https://nodejs.org/en/)\n- [Npm](https://www.npmjs.com/)\n- [Docker](https://www.docker.com/)\n\n### Technologies\n\n- NodeJs\n- Typescript\n- Express\n- TypeORM\n  - PostgreSQL\n- Yup\n- Eslint\n  - @lissone/eslint-config/node\n- Commitlint\n  - config-conventional\n- Husky\n\n### Endpoints\n\n\u003cstrong\u003eBase url: \u003c/strong\u003ehttps://localhost:5000/api/v1\n\n![GET](https://img.shields.io/badge/-GET-70BB60?style=for-the-badge)\u0026nbsp;\n/user\n\n![GET](https://img.shields.io/badge/-GET-70BB60?style=for-the-badge)\u0026nbsp;\n/user/:email\n\n![POST](https://img.shields.io/badge/-POST-2991B8?style=for-the-badge)\u0026nbsp;\n/user\n\n![PATCH](https://img.shields.io/badge/-PATCH-99768C?style=for-the-badge)\u0026nbsp;\n/user/:email\n\n![DELETE](https://img.shields.io/badge/-DELETE-DF807E?style=for-the-badge)\u0026nbsp;\n/user/:email\n\n### Usage\n\nYou can use this project as a template for another one, or clone it on your pc using the command:\n\n```bash\ngit clone https://github.com/Lissone/node-api-template.git\ncd node-api-template\n```\n\nInstall dependencies using:\n\n```bash\nnpm install\n```\n\nNeed to add environment variables:\n\n```bash\n# .\\.env\n\n# APP\nPORT=5000\n\n# POSTGRESQL\nPOSTGRESQL_HOST=localhost\nPOSTGRESQL_PORT=5432\nPOSTGRESQL_USERNAME=docker\nPOSTGRESQL_PASSWORD=docker\nPOSTGRESQL_DATABASE=exampledb\n```\n\nYou must have **Docker installed** on your machine to get the container up.\n**Up PostgreSQL service** in a **Docker container** on your local machine using:\n\n```bash\ndocker-compose up -d\n# View all running containers\ndocker ps\n```\n\nRun api:\n\n```bash\nnpm run dev\n```\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\u003ch4 align=\"center\"\u003e\n  Made with ❤️ by \u003ca href=\"https://github.com/Lissone\" target=\"_blank\"\u003eLissone\u003c/a\u003e\n\u003c/h4\u003e\n\n\u003chr /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flissone%2Fnode-api-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flissone%2Fnode-api-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flissone%2Fnode-api-template/lists"}