WikiSmith/macseem/wikismith
Live WikiSign in

Overview

What this project does

WikiSmith is an AI-powered wiki generation tool designed for code repositories. By simply pasting a GitHub URL, users can generate well-structured developer documentation that includes semantic search capabilities and AI-driven question-and-answer functionalities.

Main capabilities

  • Authentication: Users can securely sign in and manage their accounts.
  • Repository Management: Manage repository settings and sharing options efficiently.
  • Wiki Management: Create, edit, and share wikis with ease.
  • Dashboard: View an overview of user repositories and recent activities.
  • Live Wiki: Access and share live wikis for real-time collaboration.
  • Settings: Configure application settings to suit user preferences.
  • File Upload: Upload files for use in wikis and repositories.
  • User Session: Maintain user session state and relevant information.
  • API Integration: Connect with external APIs for enhanced functionality.
  • User Feedback: Collect and display user feedback and analytics.
  • Documentation: Access comprehensive project documentation and guides.
  • Public AI Wiki Sharing: Share AI-related wiki content publicly with others.

Architecture overview

WikiSmith is built using a modern tech stack that includes

  • Monorepo Management: Utilizes Turborepo and pnpm for efficient package management.
  • Frontend Framework: Developed with Next.js 16, leveraging the App Router for seamless navigation.
  • Styling: Employs Tailwind CSS and shadcn/ui for responsive and aesthetic design.
  • Database: Utilizes Neon PostgreSQL with pgvector for advanced data handling.
  • ORM: Implements Drizzle ORM and Drizzle Kit for database interactions.
  • Authentication: Integrates WorkOS for GitHub OAuth authentication.
  • AI Integration: Utilizes OpenAI's models (gpt-5-mini and text-embedding-3-small) for AI functionalities.
  • Testing Framework: Uses Vitest and Playwright for robust testing.
  • Deployment: Deployed on Vercel for high performance and scalability.

The project structure is organized into distinct directories for applications, packages, infrastructure, and documentation, ensuring clarity and maintainability.

Getting started

To get started with WikiSmith, clone the repository and install the dependencies:

git clone https://github.com/macseem/wikismith.git
cd wikismith
pnpm install

After installation, you can run the development server:

pnpm dev

Follow the setup instructions in the documentation for further configuration and deployment guidelines.