{"id":23619225,"url":"https://github.com/alexandrelamberty/hortus-api","last_synced_at":"2025-09-12T23:35:27.063Z","repository":{"id":92505103,"uuid":"369135580","full_name":"alexandrelamberty/hortus-api","owner":"alexandrelamberty","description":":seedling: Gardening Planner API.","archived":false,"fork":false,"pushed_at":"2024-09-09T06:33:21.000Z","size":8028,"stargazers_count":0,"open_issues_count":16,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-18T10:08:22.112Z","etag":null,"topics":["api","dashboard","docker","garden","gardening","greenhouse","iot","javascript","jwt","mongodb","nestjs","nodejs","planner","plants","redis","typescript"],"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/alexandrelamberty.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":"2021-05-20T08:25:39.000Z","updated_at":"2024-06-11T20:58:13.000Z","dependencies_parsed_at":"2025-05-18T16:45:39.011Z","dependency_job_id":null,"html_url":"https://github.com/alexandrelamberty/hortus-api","commit_stats":{"total_commits":123,"total_committers":1,"mean_commits":123.0,"dds":0.0,"last_synced_commit":"96dcf03a986b22b0d6af86ec6554a288c7c98284"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/alexandrelamberty/hortus-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fhortus-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fhortus-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fhortus-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fhortus-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexandrelamberty","download_url":"https://codeload.github.com/alexandrelamberty/hortus-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexandrelamberty%2Fhortus-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274893251,"owners_count":25369279,"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-09-12T02:00:09.324Z","response_time":60,"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","dashboard","docker","garden","gardening","greenhouse","iot","javascript","jwt","mongodb","nestjs","nodejs","planner","plants","redis","typescript"],"created_at":"2024-12-27T19:48:15.194Z","updated_at":"2025-09-12T23:35:25.935Z","avatar_url":"https://github.com/alexandrelamberty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build \u0026 Tests](https://github.com/alexandrelamberty/hortus-api/actions/workflows/node.yml/badge.svg)](https://github.com/alexandrelamberty/hortus-api/actions/workflows/node.yml)\n[![Docker](https://github.com/alexandrelamberty/hortus-api/actions/workflows/docker.yml/badge.svg)](https://github.com/alexandrelamberty/hortus-api/actions/workflows/docker.yml)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/19ca9ef2399847beb273a3a7fd615386)](https://www.codacy.com/gh/alexandrelamberty/hortus-api/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=alexandrelamberty/hortus-api\u0026amp;utm_campaign=Badge_Grade)\n[![codecov](https://codecov.io/gh/alexandrelamberty/hortus-api/branch/master/graph/badge.svg?token=A3VLEWDJLM)](https://codecov.io/gh/alexandrelamberty/hortus-api)\n[![DockerHub](https://img.shields.io/badge/DockerHub-images-important.svg?logo=Docker)](https://hub.docker.com/r/alexandrelamberty/hortus-api)\n\n# Hortus API\n\nGardening planner API part of the\n[Hortus](https://github.com/alexandrelamberty/hortus) project.\n\nThis application expose an API with NestJS that connect to a MongoDB and Redis databases. It use authentication/encryption with JWT and BCRYPT.\n\nThe API implement the [Hortus API Specification](https://github.com/alexandrelamberty/hortus-api-spec)\n\n## Technologies, languages, frameworks\n\n- [Docker](https://www.docker.com/)\n- [Node.js](https://nodejs.org/)\n- [NestJS](https://nestjs.com/)\n- [TypeScript](https://www.typescriptlang.org/)\n- [MongoDB](https://www.mongodb.com/)\n- [Redis](https://redis.io/)\n\n## Requirements\n\n- [Docker](https://www.docker.com/)\n- [NPM](https://www.npmjs.com/) for development\n\n## Usage\n\nThis application is part of a Docker stack. see:\n[Hortus](https://github.com/alexandrelamberty/hortus) project to run the\ncomplete stack.\n\n## Development\n\nThis API run as a Docker service and rely on a [MongoDB](https://hub.docker.com/_/mongo) database and a [Redis](https://hub.docker.com/_/redis) cache service.\n\n### Run required services\n\nSee [Hortus]()\n\n### Environment variables\n\nCreate a file named `.env` and insert the following properties\n\n```properties\nENV=dev\nPORT=3333\nPAIRING_KEY=9fca54477c8ad4e70dc5e1084f884aad\nJWT_SECRET=d7a481461577ba4c3c4c6946cca7204b\nJWT_EXPIRE=90\nBCRYPT_HASH=7f91317e30a02bc7b87205e95b842df2\nDATABASE_URI=mongodb://hortus:hortus@localhost:27017/hortus\nSTATIC_DIR=/upload\nUPLOAD_PATH=/upload\nCACHE_HOST=localhost\nCACHE_PORT=6379\nCACHE_TTL=300\nSESSION_HOST=localhost\nSESSION_PORT=6380\nSESSION_TTL=300\n```\n\nThis config will work out of the box in most case. Verify that the ports\nspecified in the configuration are not in use.\n\n### Running with NPM\n\nRun the application\n\n```bash\nnpm run start:development\n```\n\n### Tests\n\n\u003e To implement\n\n```bash\nnpm run tests\n```\n\n## Build and run with Docker\n\nBuild the image, see: [Dockerfile](./Dockerfile).\n\n```bash\ndocker build . -t alexandrelamberty/hortus-api:{tag}\n```\n\nRun the image, specify the ports mapping, environment variables file and network to join.\n\nFIXME: link source folder\n\n```bash\ndocker run -p 3333:3333 --network=hortus_default --env-file .env --name hortus-api -d alexandrelamberty/hortus-api:{tag}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexandrelamberty%2Fhortus-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexandrelamberty%2Fhortus-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexandrelamberty%2Fhortus-api/lists"}