{"id":21412629,"url":"https://github.com/tiledesk/tiledesk-server","last_synced_at":"2025-05-15T01:06:04.324Z","repository":{"id":38375364,"uuid":"131265731","full_name":"Tiledesk/tiledesk-server","owner":"Tiledesk","description":"Tiledesk Server is the main API component of the Tiledesk platform 🚀 Tiledesk is an open-source alternative to Voiceflow, allowing you to build advanced LLM-powered agents with easy human-in-the-loop (HITL) when necessary.","archived":false,"fork":false,"pushed_at":"2025-05-14T10:35:46.000Z","size":43735,"stargazers_count":343,"open_issues_count":57,"forks_count":118,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-05-14T11:47:43.588Z","etag":null,"topics":["ai-agents","ai-assistant","ai-automation","api","bot","chat","customer-service","customer-support","firebase","firestore","human-in-the-loop","javascript","mongodb","nodejs","open-source","opensource","rest","rest-api","retrieved-augmented-generation","workflow-automation"],"latest_commit_sha":null,"homepage":"http://www.tiledesk.com","language":"JavaScript","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/Tiledesk.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":"publiccode.yml","codemeta":null,"zenodo":null}},"created_at":"2018-04-27T08:03:47.000Z","updated_at":"2025-05-12T08:45:40.000Z","dependencies_parsed_at":"2023-12-18T11:25:29.131Z","dependency_job_id":"8bed5922-e74a-43d3-8b3f-1bd012664c55","html_url":"https://github.com/Tiledesk/tiledesk-server","commit_stats":{"total_commits":4789,"total_committers":13,"mean_commits":"368.38461538461536","dds":0.2758404677385675,"last_synced_commit":"13871e7cb2935b3ec6e01956c039cc21fc678474"},"previous_names":["tiledesk/tiledesk-api-nodejs"],"tags_count":1363,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiledesk%2Ftiledesk-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiledesk%2Ftiledesk-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiledesk%2Ftiledesk-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiledesk%2Ftiledesk-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tiledesk","download_url":"https://codeload.github.com/Tiledesk/tiledesk-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254254040,"owners_count":22039792,"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":["ai-agents","ai-assistant","ai-automation","api","bot","chat","customer-service","customer-support","firebase","firestore","human-in-the-loop","javascript","mongodb","nodejs","open-source","opensource","rest","rest-api","retrieved-augmented-generation","workflow-automation"],"created_at":"2024-11-22T18:14:48.947Z","updated_at":"2025-05-15T01:06:04.296Z","avatar_url":"https://github.com/Tiledesk.png","language":"JavaScript","readme":"[![npm version](https://badge.fury.io/js/%40tiledesk%2Ftiledesk-server.svg)](https://badge.fury.io/js/%40tiledesk%2Ftiledesk-server)\n\n[![CircleCI](https://circleci.com/gh/Tiledesk/tiledesk-server.svg?style=svg)](https://circleci.com/gh/Tiledesk/tiledesk-server)\n\n\n\u003e ***🚀 Do you want to install Tiledesk on your server with just one click?***\n\u003e \n\u003e ***Use [Docker Compose Tiledesk installation](https://github.com/Tiledesk/tiledesk-deployment/blob/master/docker-compose/README.md) guide***\n\n# Introduction\n\nTiledesk-server is the server engine of Tiledesk. Tiledesk is an Open Source Live Chat platform with integrated Chatbots written in NodeJs and Express. Build your own customer support with a multi-channel platform for Web, Android and iOS. \n\nDesigned to be open source since the beginning, we actively worked on it to create a totally new, first class customer service platform based on instant messaging.\n\nWhat is Tiledesk today? It became the open source “conversational app development” platform that everyone needs 😌\n\nYou can use Tiledesk to increase sales for your website or for post-sales customer service. Every conversation can be automated using our first class native chatbot technology.\nYou can also connect your own applications using our APIs or Webhooks.\nMoreover you can deploy entire visual applications inside a conversation. And your applications can converse with your chatbots or your end-users! We know this is cool 😎\n\nTiledesk is multichannel in a totally new way. You can write your chatbot scripts with images, buttons and other cool elements that your channels support. But you will configureyour chatbot replies only once. They will run on every channel, auto-adapting the responses to the target channel whatever it is, Whatsapp, Facebook Messenger, Telegram etc.\n\nMore info on Tiledesk website: https://www.tiledesk.com.\n\nYou can find technical documentation here: https://developer.tiledesk.com\n\n# Prerequisites for Installation\n\n* [Nodejs](https://www.npmjs.com/) and npm installed. Suggested versions are NodeJS 12.20.2 and NPM 6.14.11 \n* [MongoDb](https://www.mongodb.com) installed\n\n# Run Tiledesk with Docker Compose\n\nDo you want to install all the Tiledesk components on your server with just one click?\nUse [Docker Compose Tiledesk installation guide](https://github.com/Tiledesk/tiledesk-deployment/blob/master/docker-compose/README.md)\n\n# Running Tiledesk Server\n\n## Using Docker\n\n\n### Configure .env file \n```\ncurl https://raw.githubusercontent.com/Tiledesk/tiledesk-server/master/.env.sample --output .env\nnano .env #configure .env file properly\n```\n\n### Running\nIf you want to run tiledesk and mongo with docker run :\n\n```\ndocker run --name tiledesk-mongo -d mongo\ndocker run -p 3000:3000 --env DATABASE_URI=\"mongodb://mongo/tiledesk-server\" --env-file .env --link tiledesk-mongo:mongo tiledesk/tiledesk-server\n```\n\nOtherwise if you want to run tiledesk only with docker run :\n\n```\ndocker run -p 3000:3000 --env DATABASE_URI=\"mongodb://YOUR_MONGO_INSTALLATION_ENDPOINT/tiledesk-server\" --env-file .env tiledesk/tiledesk-server\n```\n\n\n\n## Run locally with npm\n\nSteps to run with npm:\n\n```\nnpm install -g @tiledesk/tiledesk-server mongodb-runner\nmongodb-runner start\ncurl https://raw.githubusercontent.com/Tiledesk/tiledesk-server/master/.env.sample --output .env\nnano .env #configure .env file properly\ntiledesk-server  \n```\n\nIf you want to load .env file from another path: `DOTENV_PATH=/MY/ABSOLUTE/PATH/.env tiledesk-server`\n\nNote: If installation with -g fails due to permission problems (npm ERR! code 'EACCES'), please refer to this [link](https://docs.npmjs.com/getting-started/fixing-npm-permissions).\n\n## Install from source code\n\n* Clone this repo\n* Install dependencies with `npm install`\n* Configure the tiledesk .env file. You can see an example in the file .env.sample under the root folder. Rename it from .env.sample to .env and configure it properly. \n* Run the app with the command `npm start`.\n\n\n## Deploy on Heroku\n\nDeploy with button:\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/Tiledesk/tiledesk-server)\n\n# Community? Questions? Support ?\nIf you need help or just want to hang out, come, say hi on our [\u003cimg width=\"15\" alt=\"Tiledesk discord\" src=\"https://seeklogo.com/images/D/discord-color-logo-E5E6DFEF80-seeklogo.com.png\"\u003e Discord](https://discord.gg/Q5A6Ewadmz) server.\n\n# REST API\n\nSee the Tiledesk REST API [here](https://developer.tiledesk.com/apis/rest-api/introduction)\n\n# Upgrading \nTo see how to upgrade tiledesk-server see [here](./docs/upgrading.md) \n\n# Testing\nRun unit test with `npm test` and integration test with `npm run test:int` \n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiledesk%2Ftiledesk-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiledesk%2Ftiledesk-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiledesk%2Ftiledesk-server/lists"}