{"id":28496253,"url":"https://github.com/AlexGalhardo/farm-nestjs-api","last_synced_at":"2025-12-30T21:51:22.170Z","repository":{"id":297659142,"uuid":"996235907","full_name":"AlexGalhardo/farm-nestjs-api.alexgalhardo.com","owner":"AlexGalhardo","description":"A simple NestJS REST CRUD API using PostgreSQL, PrismaORM, Zod, Docker, Pino Logger, Swagger OpenAPI Documentation, Unit and Integrations Tests using Jest ","archived":false,"fork":false,"pushed_at":"2025-07-04T05:44:21.000Z","size":409,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-25T16:55:33.639Z","etag":null,"topics":["api","crud","docker","integration-testing","nestjs","postgresql","prisma","rest-api","typescript","unit-test","zod"],"latest_commit_sha":null,"homepage":"https://farm-nestjs-api.alexgalhardo.com","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/AlexGalhardo.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,"zenodo":null}},"created_at":"2025-06-04T16:48:35.000Z","updated_at":"2025-07-04T05:44:25.000Z","dependencies_parsed_at":"2025-07-01T17:36:17.025Z","dependency_job_id":"6dd072e5-0bd2-446f-b6d7-94ac7faa05c8","html_url":"https://github.com/AlexGalhardo/farm-nestjs-api.alexgalhardo.com","commit_stats":null,"previous_names":["alexgalhardo/farm-nestjs-api","alexgalhardo/farm-nestjs-api.alexgalhardo.com"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AlexGalhardo/farm-nestjs-api.alexgalhardo.com","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ffarm-nestjs-api.alexgalhardo.com","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ffarm-nestjs-api.alexgalhardo.com/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ffarm-nestjs-api.alexgalhardo.com/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ffarm-nestjs-api.alexgalhardo.com/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlexGalhardo","download_url":"https://codeload.github.com/AlexGalhardo/farm-nestjs-api.alexgalhardo.com/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGalhardo%2Ffarm-nestjs-api.alexgalhardo.com/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268492423,"owners_count":24258817,"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-03T02:00:12.545Z","response_time":2577,"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":["api","crud","docker","integration-testing","nestjs","postgresql","prisma","rest-api","typescript","unit-test","zod"],"created_at":"2025-06-08T12:06:58.218Z","updated_at":"2025-12-30T21:51:22.165Z","avatar_url":"https://github.com/AlexGalhardo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eFarm NestJS API\u003c/h1\u003e\n\n\u003chttps://github.com/user-attachments/assets/b6115a84-9af7-4400-b537-11df931a126c\u003e\n\n## Technologies\n\n- [NodeJS v22](https://nodejs.org/en)\n- [NestJS v11](https://nestjs.com/)\n- [PrismaORM](https://www.prisma.io/)\n- [Docker](https://docs.docker.com/)\n- [PostgreSQL](https://www.postgresql.org/)\n\n## Prerequisites\n\n- Node v22 and NPM v11\n\n```bash\nnvm install 22.9.0\nnvm use 22.9.0\nnpm install -g npm@11.4.2\n```\n\n## Local Development Setup using Docker\n\n1. Clone repository\n\n```bash\ngit clone git@github.com:AlexGalhardo/farm-nestjs-api.git\n```\n\n2. Enter repository\n\n```bash\ncd farm-nestjs-api/\n```\n\n3. Install dependencies\n\n```bash\nnpm install\n```\n\n4. Setup your environment variables\n\n```bash\ncp .env.example .env\n```\n\n5. UP Docker with Postgres \u0026 API\n\n```bash\nsudo chmod +x setup.sh \u0026\u0026 ./setup.sh\n```\n\n6. The Server API will start Inside docker connecting to your local machine at: \u003chttp://localhost:3000\u003e\n\n## Prisma Studio (DataBase GUI)\n\n- To Start Prisma Studio:\n\n```bash\nnpm run prisma:studio\n```\n\n## Build\n\na. Creating build\n\n```bash\nnpm run build\n```\n\nb. Testing build server locally\n\n```bash\nnpm run start\n```\n\n## API Requests and Docs\n\n- You can see and use the HTTP Requests references inside folder [rest-client/](rest-client/)\n- OpenAPI Documentation (using Swagger)\n  - Local: \u003chttp://localhost:3000/api-docs\u003e\n\n## Tests\n\na. Run all unit mocked tests\n\n```bash\nnpm run test\n```\n\n\u003cimg width=\"924\" alt=\"Screenshot 2025-06-06 at 16 24 05\" src=\"https://github.com/user-attachments/assets/ac1fae3d-785c-4c0d-a251-c2e090db626a\" /\u003e\n\nb. Run all end to end tests\n\n```bash\nnpm run test:e2e\n```\n\n\u003cimg width=\"930\" alt=\"Screenshot 2025-06-06 at 14 43 15\" src=\"https://github.com/user-attachments/assets/a1510f34-6f70-4896-9123-e02267c4f4c0\" /\u003e\n\n## License\n\n[MIT](http://opensource.org/licenses/MIT)\n\nCopyright (c) June 2025-present, [Alex Galhardo](https://github.com/AlexGalhardo)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlexGalhardo%2Ffarm-nestjs-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAlexGalhardo%2Ffarm-nestjs-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlexGalhardo%2Ffarm-nestjs-api/lists"}