Skip to content

The Docomate AI backend is built using NestJS and TypeScript. For AI integration, it leverages the Groq SDK alongside LangChain. MongoDB is used as the database, with TypeORM for object-relational mapping.

Notifications You must be signed in to change notification settings

Docomate-ai/docomate-ai-backend

Repository files navigation

NodeJS NestJS TypeScript MongoDB TypeORM JWT RxJS

DocomateAI Backend

This is the backend for DocomateAI, an AI-based documentation generator and code exploration assistant. It handles user authentication, project/content management, README generation, and AI-powered chat with your codebase.

📌 For the complete project including frontend and updates, visit our GitHub organization


Table of Contents


Backend Architecture

Backend Architecture


Installation

Requirements:

  • Node JS, Nest JS and Typescript.

  • API KEYS

    API Credentials Website
    MongoDb Credentials MongoDb Atlas
    SendGrid Credentials Sendgrid Mail Service
    Jina Embeddingd API Jina v2 Embedding Modal
    Groq API Groq Console
  • To configure environment variables, navigate to the backend directory and copy .env.development.sample to .env.development. Then, paste your API keys from the above links.

Local Installation

  1. Clone the repository

    git clone https://github.com/Docomate-ai/docomate-ai-backend.git
    cd docomate-ai-backend
    
  2. Install dependencies

    npm install
    
  3. Set up environment variables Create a .env.development file in the root directory. Refer to .env.development.sample for structure.

  4. Start the server

    npm run start:dev
    

Tech stack

Technology Tools
Server-side Runtime Node.js
Web Framework Nest.js with Typescript
Database MongoDB, TypeORM
Authentication JWT, Bcryptjs
AI-based Features Groq-sdk, Langchain.js, Jina embeddings
API Testing Postman
Deployment Heroku

Author

Gitanshu Sankhla


Feel free to contribute, raise issues, or suggest improvements!

About

The Docomate AI backend is built using NestJS and TypeScript. For AI integration, it leverages the Groq SDK alongside LangChain. MongoDB is used as the database, with TypeORM for object-relational mapping.

Topics

Resources

Stars

Watchers

Forks