Allinol - AI-Driven Business Automation Platform (MVP STAGE)

Allinol is a comprehensive business automation platform that centralizes company operations through a cross-platform application, integrating neural networks and third-party services.

Features

• Process Automation Engine: Integration with automation tools
• Third-Party Service Integrations: Short links, email marketing, social media publishing, and more
• AI-Driven Automation: AI-powered recommendations for workflow optimization
• Data & Entity Management: Store, manage, and structure key business data
• Documentation & Knowledge Management: AI-assisted document classification and retrieval
• Visual Database Management: Integration with Apitable, NocoDB

Project Structure

The project is divided into two main parts:

Stack &Tech:

• FrontEnd: React 19 with Typescript, Vite 6, React Router, TailwindCss,Shadncn, Axios, React Query
• Backend: Node.js with Typescript, Express.js, MongoDb, Grog Deployment: Render

Getting Started

Prerequisites

• Node.js (v14 or higher)
• MongoDB (local or Atlas)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/allinol.git
   cd allinol
   

2. Install server dependencies:

   cd server
   npm install
   

3. Install client dependencies:

   cd ../client
   npm install
   

4. Set up environment variables:

   • Create a .env file in the server directory based on .env.example
   • Create a .env file in the client directory based on .env.example

Running the Application

1. Start the server:

   cd server
   npm run dev
   

2. Start the client:

   cd ../client
   npm run dev
   

3. Open your browser and navigate to http://localhost:5173

Development Roadmap

1. PRD to AI Task Breakdown

   • AI-powered PRD analysis
   • Task extraction & role categorization
   • Basic CRUD for managing tasks
   • API + simple frontend for viewing tasks

2. Entity System + RBAC

   • Build core database models
   • Implement entity relationships
   • Role-based access control
   • File storage integration

3. Full Automation & Integrations

   • Process automation
   • AI-powered project strategy & roadmap
   • API integrations
   • Advanced visual dashboards

License

This project is licensed under the MIT License - see the LICENSE file for details.

Repository Documentation Generator

Automatically generate comprehensive documentation for any GitHub repository using AI.

Features

• 🤖 Uses Google's Gemini 1.5 Flash AI to analyze repositories
• 📚 Creates structured Markdown documentation
• 🔄 Runs automatically on code changes
• 🔍 Identifies key components, architecture, and code structure
• 🔧 Works with any programming language
• ⚡ Efficiently processes repositories of any size
• 🪝 Webhook integration for automatic documentation updates

Getting Started

As a GitHub Action in your repository

The easiest way to use this tool is as a GitHub Action in your repository.

1. In your repository, create a workflow file at .github/workflows/docs.yml with:

name: Generate Repository Documentation

on:
  push:
    branches: [ main ]
  workflow_dispatch:

jobs:
  generate-docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - name: Generate Documentation
        uses: All1nol/repo-docs-generator@v1
        with:
          gemini_api_key: ${{ secrets.GEMINI_API_KEY }}

2. Add your Gemini API key to repository secrets (Settings → Secrets → Actions)

Using webhooks for automatic updates

You can set up webhooks to automatically update documentation whenever code is pushed to your repository:

1. Create a webhook in your GitHub repository settings (Settings → Webhooks → Add webhook)
2. Point it to your Allinol server's webhook endpoint: https://your-server.com/api/webhooks/github
3. Set content type to application/json and add a secret key
4. Select "Just the push event"
5. Add the webhook secret to your server's environment variables

See docs/webhook-setup.md for detailed instructions.

Using the CLI tool locally

You can also run the tool locally:

1. Clone this repository
2. Install dependencies:

   cd server
   npm install
   npm install @google/generative-ai --save

3. Create a .env file in the server directory with:

   GITHUB_TOKEN=your_github_token
   GEMINI_API_KEY=your_gemini_api_key
   GEMINI_MODEL=gemini-1.5-flash
   

4. Run the documentation generator:

   cd server
   npx ts-node src/automation/repo-docs.ts https://github.com/username/repo --full-scan

How It Works

1. The tool uses GitHub's API to efficiently fetch all files from a repository
2. It analyzes the repository structure to understand components and relationships
3. Key files are selected and analyzed for context
4. The Gemini AI model generates comprehensive documentation based on the analysis
5. The documentation is saved as Markdown files in the docs directory

Documentation Output

The generated documentation includes:

• Project overview and purpose
• Repository structure
• Key components and their relationships
• Setup instructions
• Usage examples
• Code architecture

Configuration Options

GitHub Action

See .github/actions/repo-docs-generator/README.md for all available options.

CLI Tool

ts-node src/automation/repo-docs.ts <github-repo-url> [branch] [--full-scan]

• <github-repo-url>: The URL of the GitHub repository to document
• [branch]: The branch to scan (default: main)
• [--full-scan]: Whether to scan the entire repository (recommended)

License

This project is licensed under the MIT License - see the LICENSE file for details.