{"id":15097771,"url":"https://github.com/tech-warriors-corporation/harvtech-platform-api","last_synced_at":"2026-02-26T01:08:57.647Z","repository":{"id":237096766,"uuid":"793805333","full_name":"tech-warriors-corporation/harvtech-platform-api","owner":"tech-warriors-corporation","description":"The API to manage communication between other services in HarvTech.","archived":false,"fork":false,"pushed_at":"2024-09-12T23:20:23.000Z","size":858,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-19T12:18:09.203Z","etag":null,"topics":["api","commitlint","cors","eslint","husky","jest","koajs","nodejs","postgresql","prettier","typescript"],"latest_commit_sha":null,"homepage":"https://harvtech-platform-api.onrender.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tech-warriors-corporation.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":"2024-04-29T22:40:47.000Z","updated_at":"2024-09-12T23:20:20.000Z","dependencies_parsed_at":"2024-06-22T14:22:58.527Z","dependency_job_id":"1e852856-bbc7-47a2-8095-a4abd59f1bf5","html_url":"https://github.com/tech-warriors-corporation/harvtech-platform-api","commit_stats":null,"previous_names":["tech-warriors-corporation/harvtech-platform-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tech-warriors-corporation/harvtech-platform-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tech-warriors-corporation%2Fharvtech-platform-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tech-warriors-corporation%2Fharvtech-platform-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tech-warriors-corporation%2Fharvtech-platform-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tech-warriors-corporation%2Fharvtech-platform-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tech-warriors-corporation","download_url":"https://codeload.github.com/tech-warriors-corporation/harvtech-platform-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tech-warriors-corporation%2Fharvtech-platform-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29846984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-25T22:37:40.667Z","status":"ssl_error","status_checked_at":"2026-02-25T22:37:25.960Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","commitlint","cors","eslint","husky","jest","koajs","nodejs","postgresql","prettier","typescript"],"created_at":"2024-09-25T16:40:29.569Z","updated_at":"2026-02-26T01:08:57.630Z","avatar_url":"https://github.com/tech-warriors-corporation.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg align=\"center\" src=\"./assets/logo.svg\" width=\"120px\" alt=\"HarvTech logo\" /\u003e\n    \u003cbr\u003e\n    \u003ch1 align=\"center\"\u003eHarvTech (API platform)\u003c/h1\u003e\n    \u003cp align=\"center\"\u003eThe API to manage communication between other services in HarvTech.\u003c/p\u003e\n    \u003cp align=\"center\"\u003e\n        \u003ca href=\"https://github.com/prettier/prettier\"\u003e\u003cimg align=\"center\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\" alt=\"Code style is Prettier\" /\u003e\u003c/a\u003e\n        \u003ca href=\"https://github.com/tech-warriors-corporation/harvtech-platform-api/blob/main/LICENSE\"\u003e\u003cimg align=\"center\" src=\"https://img.shields.io/github/license/tech-warriors-corporation/harvtech-platform-api\" alt=\"GitHub license\" /\u003e\u003c/a\u003e\n        \u003cimg align=\"center\" src=\"https://img.shields.io/github/repo-size/tech-warriors-corporation/harvtech-platform-api\" alt=\"GitHub repository size\" /\u003e\n    \u003c/p\u003e\n\u003c/p\u003e\n\n\u003chr\u003e\n\n## Install prerequisites\n1. [NodeJS and NPM](https://nodejs.org/en/download).\n2. [Yarn](https://classic.yarnpkg.com/lang/en/docs/install).\n\n## Setup project\nFollow all commands bellow.\n\n### Environment\nCreate **.env** file in **root** folder with content.\n```\nWEB_URL=\u003cset Web URL 🔑\u003e\nAI_URL=\u003cset AI URL 🔑\u003e\nJWT_SECRET=\u003cset JWT secret 🔑\u003e\nJWT_EXPIRES=\u003cset JWT expires 🔑\u003e\nAZURE_ACCOUNT_NAME=\u003cset Azure account name 🔑\u003e\nAZURE_ACCOUNT_KEY=\u003cset Azure account key 🔑\u003e\nAZURE_STORAGE_CONTAINER_URL=\u003cset storage container URL 🔑\u003e\nDB_HOST=\u003cset database host 🔑\u003e\nDB_DOCKER_PORT=\u003cset Docker database port 🔑\u003e\nDB_PORT=\u003cset database port 🔑\u003e\nDB_NAME=\u003cset database name 🔑\u003e\nDB_USERNAME=\u003cset database username 🔑\u003e\nDB_PASSWORD=\u003cset database password 🔑\u003e\nCRYPTO_ALGORITHM=\u003cset crypto algorithm 🔑\u003e\nCRYPTO_KEY=\u003cset crypto key 🔑\u003e\nCRYPTO_IV=\u003cset crypto IV 🔑\u003e\nPORT=\u003cset port 🔑\u003e\nMODE=\u003cset mode 🔑\u003e\n```\n\n### Install packages\n```\nyarn\n```\n\n### Active Husky hooks (if not automatically configured)\n```\nyarn prepare\n```\n\n### Database in Docker\n```\nyarn db\n```\n\n### Development\n```\nyarn dev\n```\n\n### Production\n```\nyarn prod:build \u0026\u0026 yarn prod:start\n```\n\n### Tests\nOur tests are made with [Jest](https://jestjs.io). Use `*.test.ts` for integration tests and `*.spec.ts` for unit tests. Run the commands below.\n\n#### Default\n``` \nyarn test \n```\n\n#### Watch\n``` \nyarn test:watch\n```\n\n#### Quiet\n``` \nyarn test:quiet\n```\n\n#### Coverage\n``` \nyarn test:coverage\n```\n\n### Migrations (TypeORM):\nIn this project we use [TypeORM](https://typeorm.io) for migrations. Run the commands below.\n\n#### Run\n```\nyarn migration:run\n```\n\n#### Generate\n```\nyarn migration:generate src/migrations/\u003cname\u003e\n```\n\n#### Synchronize\n```\nyarn schema:sync\n```\n\n## Setup JetBrains (IDE)\n\n### Configure Lint\nGo to `File \u003e Settings \u003e Languages \u0026 Frameworks \u003e JavaScript \u003e Code Quality Tools \u003e ESLint`, select **Automatic ESLint configuration** and check **Run eslint --fix on save**, or read the [ESLint documentation for WebStorm](https://www.jetbrains.com/help/webstorm/eslint.html).\n\n### Configure Prettier\nGo to `File \u003e Settings \u003e Languages \u0026 Frameworks \u003e JavaScript \u003e Prettier`, check **On 'Reformat Code' action** and check **On save**, or read the [Prettier documentation for WebStorm](https://www.jetbrains.com/help/webstorm/prettier.html).\n\n## Lint\nRun commands:\n\n### Check\n```\nyarn lint\n```\n\n### Fix\n```\nyarn lint:fix\n```\n\n## Prettier\nRun commands:\n\n### Check\n```\nyarn prettier\n```\n\n### Fix\n```\nyarn prettier:fix\n```\n\n## Format code\n```\nyarn format\n```\n\n## File patterns\nYou should be very specific in file names.\n\n## Roadmap\n- [X] Add [Axios](https://axios-http.com).\n- [X] Add [Jest](https://jestjs.io).\n- [X] Study about [Azure SDK for JS](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob/samples/v12/typescript).\n- [X] Review code in `review` directory.\n- [X] Config project.\n- [X] Add coverage code.\n- [X] Review project.\n- [X] Storage in Danilo's Azure.\n- [X] Add [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) and test it.\n- [X] Add [PostgreSQL](https://www.postgresql.org).\n- [X] Use [Crypto](https://www.w3schools.com/nodejs/ref_crypto.asp) from NodeJS with algorithm AES-256-CTR.\n- [X] Add [JWT](https://jwt.io) to authenticate requests.\n- [X] Use an ORM for PostgreSQL.\n- [ ] Add a logger.\n- [X] Protect passwords with a pattern with numbers, chars and symbols, use minlength too.\n- [X] Add test in CI/CD.\n- [X] Add environment variables in Cloud.\n- [X] Protect routes with token.\n- [X] UUID to avoid sequential ids.\n- [X] Render or Neon for PostgreSQL.\n- [ ] Remove TODO comments.\n- [ ] Coverage badge in this `README.md`.\n- [X] Study about [TypeORM](https://typeorm.io).\n- [ ] Add header with secret key for validate request to AI.\n- [ ] Make the code more agnostic of framework, library and other tools.\n- [X] Validate our requests with access token.\n- [ ] Protect routes with account types.\n- [X] Create `SanitizeHelper` for entries.\n- [X] Maybe use Bcrypt.\n- [X] Add health check.\n- [ ] Verify user quantities and cultive quantities by account plan.\n- [X] Run OWASP ZAP test.\n\n## Thanks for read\nProduct made by **[Tech Warriors](https://github.com/tech-warriors-corporation)**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftech-warriors-corporation%2Fharvtech-platform-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftech-warriors-corporation%2Fharvtech-platform-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftech-warriors-corporation%2Fharvtech-platform-api/lists"}