{"id":13990028,"url":"https://github.com/telepat-io/telepat-api","last_synced_at":"2025-12-30T00:05:22.073Z","repository":{"id":65478517,"uuid":"38115220","full_name":"telepat-io/telepat-api","owner":"telepat-io","description":"This is the Telepat API where HTTP calls are made. CRUD operations are not processed here directly. Messages are sent to the Telepat workers where CRUD operations are being taken care of along with client communication (notifications).","archived":false,"fork":false,"pushed_at":"2017-08-25T09:26:24.000Z","size":1009,"stargazers_count":332,"open_issues_count":6,"forks_count":21,"subscribers_count":19,"default_branch":"develop","last_synced_at":"2024-11-24T14:02:58.260Z","etag":null,"topics":["notifications","realtime","scalability","synchronization"],"latest_commit_sha":null,"homepage":"http://telepat.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/telepat-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-26T14:22:28.000Z","updated_at":"2024-01-30T19:51:57.000Z","dependencies_parsed_at":"2023-01-25T07:45:23.584Z","dependency_job_id":null,"html_url":"https://github.com/telepat-io/telepat-api","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telepat-io%2Ftelepat-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telepat-io%2Ftelepat-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telepat-io%2Ftelepat-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telepat-io%2Ftelepat-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/telepat-io","download_url":"https://codeload.github.com/telepat-io/telepat-api/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227089499,"owners_count":17729476,"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":["notifications","realtime","scalability","synchronization"],"created_at":"2024-08-09T13:02:17.257Z","updated_at":"2025-12-30T00:05:22.044Z","avatar_url":"https://github.com/telepat-io.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/telepat-io/telepat-api.svg?branch=develop)](https://travis-ci.org/telepat-io/telepat-api) [![Test Coverage](https://codeclimate.com/github/telepat-io/telepat-api/badges/coverage.svg)](https://codeclimate.com/github/telepat-io/telepat-api/coverage) [![Code Climate](https://codeclimate.com/github/telepat-io/telepat-api/badges/gpa.svg)](https://codeclimate.com/github/telepat-io/telepat-api) [![David](https://img.shields.io/david/telepat-io/telepat-api.svg)](https://david-dm.org/telepat-io/telepat-api)\n\n# Telepat API\n\nThis is the Telepat API where all api calls are made. CRUD operations are not processed here directly. Messages are\nsent to the Telepat workers where CRUD operations are being taken care of along with client communication (notifications)\n\n## Quick startup guide\n\nTo start the API server all you need to do is run one command:\n\n`./bin/www`\n\nYou can optionally tell the server to listen another port (default is `3000`) by setting the environment variable PORT.\nThe API server will try and connect to each of the services until they are available (kafka, couchbase, elasticsearch).\n\n## Configuring\n\nThere are two ways to configure: either by using the `config.example.json` config file (rename it into config.json)\nor by setting up environment variables (this method is the most convenient):\n\n* `TP_MSG_QUE`: Name of the messaging client you want to use. Should be the same as the exported variable in\ntelepat-models\n* `TP_MAIN_DB`: Name of the main database which to use. Should be the same as the exported variable in telepat-models\n* `TP_PW_SALT`: Password salt used for hashing passwords\n\n**Important**: You need to set up the other config variables specified in the `telepat-models` README file for resources\nthat you're using.\n\n## Testing\n\nTo run just the tests using mocha (make sure you have installed globally `npm install mocha`):\n\n* `mocha api.js` in the test folder\n* `npm test` in the root folder will also run istanbul (make sure you install it globally) code coverage tool\n\n**Notice**: the testing suite automatically starts the API server but **NOT** the telepat workers. You should start them\nbefore running the tests.\n\nAPI documentation can be found here: [http://docs.telepat.io/api-docs.html](http://docs.telepat.io/api-docs.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelepat-io%2Ftelepat-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelepat-io%2Ftelepat-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelepat-io%2Ftelepat-api/lists"}