Skip to content

Cloud-Code-AI/AkiraDocs

Repository files navigation

AkiraDocs

AI-powered API docs and test generator

Introduction

AkiraDocs is an innovative tool designed to streamline the process of creating API documentation and generating tests for your projects. By leveraging the power of artificial intelligence, AkiraDocs automates the tedious task of writing comprehensive documentation and crafting effective test cases, allowing developers to focus on building great software.

Key features:

  • Automatic API documentation generation
  • Intelligent test case creation
  • Easy integration with existing projects
  • Customizable output formats

Try It Out

You can try AkiraDocs without installation by visiting our live demo at https://akiradocs.com.

Steps to Run

Follow these steps to get AkiraDocs up and running using Docker:

  1. Clone the repository:

    git clone https://github.com/yourusername/AkiraDocs.git
    
  2. Navigate to the project directory:

    cd AkiraDocs
    
  3. Build and start the Docker containers:

    docker-compose up --build
    
  4. Access AkiraDocs at http://localhost:3000 (or the port specified in your docker-compose.yml).

  5. To stop the containers, use:

    docker-compose down
    

Presentation

To learn more about AkiraDocs and its capabilities, check out our Canva presentation.

Screenshots

BeforeGeneration GeneratedAPI

License

AkiraDocs is released under the MIT License.