crawlchat

crawlchat

Turn your documentation into an AI assistant that answers questions instantly

Stars: 79

Visit
 screenshot

CrawlChat is an open sourced AI-powered platform that transforms technical documentation into intelligent chatbots. It allows users to connect documentation from various sources and deploy AI assistants that can answer questions across multiple channels. The platform includes services like front-facing React app, Express app, Discord bot, Slack app, and more. Users can self-host the platform using Dockerfiles and set up environment variables for easy deployment. Local development is quick and easy, allowing users to contribute by starting the necessary services and making improvements or adding features.

README:

CrawlChat

CrawlChat is an open sourced AI-powered platform that transforms your technical documentation into intelligent chatbots. Connect your documentation from various sources and deploy AI assistants that understand your content and answer questions across multiple channels including websites, Discord, Slack, and as an MCP server for integration with AI development tools.

Deploy on Railway

You can self host it yourself or let CrawlChat handle it for you!

Services

Here are the services it consists of. They are mostly simple Node + TypeScript apps.

Name Purpose Run
front The front facing React Router 7 app npm run dev
server LLM interacting Express app npm run dev
source-sync A BullMQ app for syncing the sources and KB npm run dev
discord-bot Discord bot to answer questions npm run dev
slack-app Slack app to answer questions npm run dev
marker Turn files into markdown ./start.sh

Self-host

Check out the self-host guide for more details. There are Dockerfiles for all the above mentioned services. You can instantly host on platforms like Coolify, Railway, etc. by just setting up the environment variables

See the docker-compose.yml on how to set up all basic services automatically.

Local development

It takes just a few minutes to run it on your local machine so that you can develop on it and send PRs. It is explained in LOCAL.md

Contribution

It should be pretty straight forward process. Clone the repository locally and start the front, server, source-sync to get started. Make sure you add the .env files in the services with appropriate values as mentioned in env.example files respectively.

Feel free to raise a Pull request if you find any improvement, interesting feature addition, fixes for bugs!

License

It is available on a O'Saasy license. Go to LICENSE

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for crawlchat

Similar Open Source Tools

For similar tasks

For similar jobs