Napi

🚀 napi - A Superior Software Architecture Tool in the AI Era

napi is a powerful automation tool developed by NanoAPI. It aims to help you automatically analyze the architectural complexity of your codebase and offers innovative ways to break down existing functionality into smaller units. This tool integrates a robust Command-Line Interface (CLI) and an intuitive User Interface (UI), and is compatible with all major CI/CD platforms, allowing it to seamlessly fit into your development and deployment processes.

For a long time, such tools were only accessible to large consulting firms or contractors, hidden behind the barrier of consulting fees. napi aims to break this status quo, enabling developers of all skill levels to use these tools easily without any cost. Our vision is to help you gain in - depth insights into the architectural issues of your system before potential problems turn into significant expenses. Additional benefits include no longer relying on black - box tools to analyze your code and the peace of mind that comes with a fully deterministic tool.

✨ Features

• 🚨 Review: Identify code areas that need refactoring or cleaning.
• 📝 Refactor: Extract functionality through the UI to improve architectural design.
• 🏗️ Build: Generate modular microservices that can be directly deployed.
• ⚙️ Integrate: Automate using CLI commands compatible with all CI/CD workflows.

🚀 Quick Start

Why Choose napi?

• Discover possibilities in legacy systems: Identify problematic code early and explore its potential uses.
• Turn small changes into big impacts: Change your working style through modular development and improve efficiency.
• Redefine architectural principles: Build future systems in a more flexible and scalable way.

📦 Installation

To use napi in your project, follow these steps:

1. Clone or download this repository.
2. Install it using the following command:

npm install napi-cli --save-dev

3. Create a napi.config.js file in the root directory of your project and add the necessary configurations.

💻 Usage Examples

Basic Usage

Run the following command in the terminal:

napi init

This will guide you through the initial setup process. After completion, you can start the service using the following command:

napi serve

Advanced Usage

To customize the behavior, edit the napi.config.js file and add the required plugins or configurations.

📚 Documentation

For detailed information on integrating with platforms such as GitHub Actions, GitLab CI/CD, and Jenkins, as well as other advanced features, please refer to our documentation page.

🤝 Contribution Guidelines

We welcome your code contributions. Please read our Contribution Guidelines for specific details.

📄 License

napi is distributed under the Sustainable Use License.

📖 Further Reading

• Automating the “Beast Mode”: Redefining Architecture with Microlithic Development
• The Rise of the “Microlith”: Rethinking Microservices for Modern Developers

💸 Donation Instructions

NanoAPI is a fair - source project. Based on this principle, we believe it is unethical to keep donations for ourselves. Therefore, we handle donations as follows:

• All donations go into a public pool.
• The funds in the pool will be distributed to contributors.
• At the end of the year, any remaining funds will be donated to a charity chosen by the community. We will regularly update the amount of funds in the pool and their distribution.