Skip to content

The Docomate AI frontend is built with React, TypeScript, and Vite. For component styling, it uses ShadCN integrated with TailwindCSS. API communication with the backend is handled using React Query in combination with Axios.

Notifications You must be signed in to change notification settings

Docomate-ai/docomate-ai-frontend

Repository files navigation

React TypeScript TailwindCSS Vite React Router

DocomateAI Frontend

The frontend for DocomateAI, a smart AI-powered documentation assistant that helps developers auto-generate project documentation, preview markdown output, and interact with their codebase visually and intuitively.

📌 For the backend and full-stack implementation, visit our GitHub organization


Table of Contents


Features

  • Sleek, responsive UI built with ShadCn + TailwindCSS
  • AI integration to generate READMEs and chat with codebase.
  • Markdown editing and live preview support
  • Secure user authentication (via backend API)
  • Seamless API interaction with Groq.
  • Built with Vite for super fast dev experience

Screenshots

Login Page

Login Page

Dashboard

Dashboard

Project Page

Project Page

Readme Section Selection Page

Readme Sections

Readme Output Page

Readme Output Page

Save Readme Page with Download Btn (in Dark Mode)

Saved Readme Preview

Chat Page (in Dark Mode)

Chat Page

Chat Page with response

Chat Response

Profile Page (in Dark Mode)

Profile

Settings Page (in Dark Mode)

Settings

Installation

Requirements

  • Node.js (v18+ recommended)
  • npm

Steps

  1. Clone the repository

    git clone https://github.com/docomate-ai/docomate-ai-frontend.git
    cd docomate-ai-frontend
  2. Installing Dependencies

    npm install
  3. Update the axios configuration: Open src/lib/axios.ts and do following changes.

    axios.defaults.baseURL = "<write your backend URL>";
  4. Start the development server:

    npm run dev
  5. Open http://localhost:5173 in your browser.

Wanna Try It

Author

  • Gitanshu Sankhla

    GitHub-social LinkedIn-social Instagram-social

About

The Docomate AI frontend is built with React, TypeScript, and Vite. For component styling, it uses ShadCN integrated with TailwindCSS. API communication with the backend is handled using React Query in combination with Axios.

Topics

Resources

Stars

Watchers

Forks

Languages