{"id":15395666,"url":"https://github.com/jusemon/botkeeping-api","last_synced_at":"2026-02-04T06:31:31.522Z","repository":{"id":108040459,"uuid":"583833494","full_name":"jusemon/botkeeping-api","owner":"jusemon","description":"A backend demo project","archived":false,"fork":false,"pushed_at":"2024-10-04T17:24:52.000Z","size":2776,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-29T10:43:24.556Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://botkeeping.jusemon.com/api/v1/","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/jusemon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2022-12-31T04:54:36.000Z","updated_at":"2024-10-04T17:24:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"5c8ee9a0-0d0a-4247-bb7a-187e6d3036de","html_url":"https://github.com/jusemon/botkeeping-api","commit_stats":{"total_commits":22,"total_committers":2,"mean_commits":11.0,"dds":"0.045454545454545414","last_synced_commit":"52328a5419b0d4ebf533cead01305a87bbd49f4a"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jusemon/botkeeping-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jusemon%2Fbotkeeping-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jusemon%2Fbotkeeping-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jusemon%2Fbotkeeping-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jusemon%2Fbotkeeping-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jusemon","download_url":"https://codeload.github.com/jusemon/botkeeping-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jusemon%2Fbotkeeping-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264995121,"owners_count":23694884,"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":[],"created_at":"2024-10-01T15:29:06.584Z","updated_at":"2026-02-04T06:31:26.488Z","avatar_url":"https://github.com/jusemon.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botkeeping API\n\n## Requirements\n\n- Last stable version of redis\n- Last stable version of MySQL/MariaDB\n- A PC\n\n## Installation\n\nFor run locally it needs a `.env` file with the environment variables defined in\nthe `.env.example`\n\nThe database scripts are under the scripts folder, please run them in order.\n\n### Development\n\nALLOWED_ORIGINS includes a comma-separated list of the allowed CORS sites.\n\nInstall dependencies `npm install` or `yarn` To start the project run\n`npm run dev` or `yarn dev`\n\n### Production\n\nFor run it in docker just run `docker compose up`\n\nAlternatively, you can run the image without cloning this repo using the image\npublished\n[here](https://git.jusemon.com/jusemon/-/packages/container/botkeeping-api/1.0.0)\n\nWith docker run (replace ${ENV_VARIABLE} with your values):\n\n```sh\ndocker run -p ${PORT}:${PORT} -e NODE_ENV=${NODE_ENV} -e HOST=${HOST} -e PORT=${PORT} -e API_VERSION=${API_VERSION} -e ALLOWED_ORIGINS=${ALLOWED_ORIGINS} -e DB_HOST=${DB_HOST} -e DB_DATABASE=${DB_DATABASE} -e DB_USER=${DB_USER} -e DB_PASSWORD=${DB_PASSWORD} -e DB_PORT=${DB_PORT} -e REDIS_HOST=${REDIS_HOST} -e REDIS_PORT=${REDIS_PORT} git.jusemon.com/jusemon/botkeeping-api:1.0.0\n```\n\nWith docker compose (the ${ENV_VARIABLE} will be taken from the .env\nautomatically):\n\n```yaml\nname: botkeeping\nservices:\n  api:\n    image: git.jusemon.com/jusemon/botkeeping-api:1.0.0\n    ports:\n      - ${PORT}:${PORT}\n    environment:\n      NODE_ENV: ${NODE_ENV}\n      HOST: ${HOST}\n      PORT: ${PORT}\n      API_VERSION: ${API_VERSION}\n      ALLOWED_ORIGINS: ${ALLOWED_ORIGINS}\n      DB_HOST: ${DB_HOST}\n      DB_DATABASE: ${DB_DATABASE}\n      DB_USER: ${DB_USER}\n      DB_PASSWORD: ${DB_PASSWORD}\n      DB_PORT: ${DB_PORT}\n      REDIS_HOST: ${REDIS_HOST}\n      REDIS_PORT: ${REDIS_PORT}\n```\n\n## Libraries Used\n\n- bullmq (for asynchronous work)\n- threads (for asynchronous work)\n- koa (for api rest)\n- mysql2 (for database operations)\n\n## Credits\n\n- Created by Juan Sebastián Montoya\n\n## License\n\nThis project is licensed under the\n[MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjusemon%2Fbotkeeping-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjusemon%2Fbotkeeping-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjusemon%2Fbotkeeping-api/lists"}