|
| 1 | +# CodinIT.dev Docs |
| 2 | + |
| 3 | +This repository contains the official documentation for **CodinIT**, an AI-powered full-stack development platform that revolutionizes how developers build applications with local and cloud AI models. |
| 4 | + |
| 5 | +## 🚀 What is CodinIT? |
| 6 | + |
| 7 | +CodinIT is a comprehensive development environment that integrates AI assistance throughout the entire development workflow. It supports 19+ AI providers including OpenAI, Anthropic, Google, DeepSeek, and more, offering: |
| 8 | + |
| 9 | +- **Smart Code Generation**: AI-powered code completion and generation |
| 10 | +- **Full-Stack Development**: Built for Node.js full-stack applications |
| 11 | +- **Multiple AI Providers**: Connect with your preferred AI models |
| 12 | +- **Integrated Tools**: Terminal, file management, and deployment |
| 13 | +- **Local Model Support**: Run AI models locally with Ollama and LM Studio |
| 14 | +- **Enterprise Security**: Bank-level security and compliance |
| 15 | + |
| 16 | +## 📚 Documentation Structure |
| 17 | + |
| 18 | +This documentation site is built with [Mintlify](https://mintlify.com) and covers: |
| 19 | + |
| 20 | +- **Getting Started**: Quickstart guides and installation |
| 21 | +- **Features**: Development tools, AI integration, and workflows |
| 22 | +- **Providers**: Configuration for 19+ AI providers |
| 23 | +- **Integrations**: Vercel, Netlify, Supabase, and Git |
| 24 | +- **MCP Protocol**: Extending capabilities with custom tools |
| 25 | +- **Comparisons**: How CodinIT compares to other platforms |
| 26 | + |
| 27 | +## 🛠️ Development Setup |
| 28 | + |
| 29 | +### Prerequisites |
| 30 | + |
| 31 | +- Node.js 18+ |
| 32 | +- pnpm, npm, or yarn |
| 33 | + |
| 34 | +> **Important**: If you have a package named `mint` and a package named `mintlify` installed, you should uninstall `mintlify`. |
| 35 | +> |
| 36 | +> 1. Uninstall the old package: |
| 37 | +> ```bash |
| 38 | +> npm uninstall -g mintlify |
| 39 | +> ``` |
| 40 | +> |
| 41 | +> 2. Clear your npm cache: |
| 42 | +> ```bash |
| 43 | +> npm cache clean --force |
| 44 | +> ``` |
| 45 | +> |
| 46 | +> 3. Reinstall the new package: |
| 47 | +> ```bash |
| 48 | +> npm i -g mint |
| 49 | +> ``` |
| 50 | +
|
| 51 | +### Local Development |
| 52 | +
|
| 53 | +1. **Clone the repository** |
| 54 | + ```bash |
| 55 | + git clone https://github.com/codinit-dev/docs.git |
| 56 | + cd docs |
| 57 | + ``` |
| 58 | +
|
| 59 | +2. **Install dependencies** |
| 60 | + ```bash |
| 61 | + # Using pnpm (recommended) |
| 62 | + pnpm install |
| 63 | + |
| 64 | + # Or using npm |
| 65 | + npm install |
| 66 | + |
| 67 | + # Or using yarn |
| 68 | + yarn install |
| 69 | + ``` |
| 70 | + |
| 71 | +3. **Start the development server** |
| 72 | + ```bash |
| 73 | + # Using pnpm |
| 74 | + pnpm dev |
| 75 | + |
| 76 | + # Or using npm |
| 77 | + npm run dev |
| 78 | + |
| 79 | + # Or using yarn |
| 80 | + yarn dev |
| 81 | + ``` |
| 82 | + |
| 83 | +4. **Open your browser** to `http://localhost:3000` |
| 84 | + |
| 85 | +### Building for Production |
| 86 | + |
| 87 | +```bash |
| 88 | +# Build the documentation site |
| 89 | +pnpm build |
| 90 | + |
| 91 | +# Preview the production build |
| 92 | +pnpm preview |
| 93 | +``` |
| 94 | + |
| 95 | +## 📝 Contributing |
| 96 | + |
| 97 | +We welcome contributions to improve the documentation! Here's how you can help: |
| 98 | + |
| 99 | +### Content Contributions |
| 100 | + |
| 101 | +1. **Fork** this repository |
| 102 | +2. **Create a feature branch**: `git checkout -b feature/your-feature-name` |
| 103 | +3. **Make your changes** to the MDX files in the appropriate directories |
| 104 | +4. **Test your changes** locally with `pnpm dev` |
| 105 | +5. **Commit your changes** following conventional commit format |
| 106 | +6. **Push to your fork** and create a **Pull Request** |
| 107 | + |
| 108 | +### Documentation Guidelines |
| 109 | + |
| 110 | +- Use clear, concise language |
| 111 | +- Include code examples where helpful |
| 112 | +- Follow the existing MDX structure and component usage |
| 113 | +- Test all links and ensure they're working |
| 114 | +- Use proper heading hierarchy (H1 → H2 → H3) |
| 115 | + |
| 116 | +### File Structure |
| 117 | + |
| 118 | +``` |
| 119 | +docs/ |
| 120 | +├── index.mdx # Homepage |
| 121 | +├── quickstart.mdx # Getting started guide |
| 122 | +├── features/ # Feature documentation |
| 123 | +├── providers/ # AI provider guides |
| 124 | +├── integrations/ # Third-party integrations |
| 125 | +├── essentials/ # Core functionality |
| 126 | +├── mcp/ # MCP protocol docs |
| 127 | +├── comparisons/ # Platform comparisons |
| 128 | +├── running-models-locally/ # Local AI setup |
| 129 | +└── assets/ # Images, icons, and media |
| 130 | +``` |
| 131 | + |
| 132 | +## 🔧 Configuration |
| 133 | + |
| 134 | +The documentation is configured through `docs.json`: |
| 135 | + |
| 136 | +- **Theme**: Aspen theme with custom colors |
| 137 | +- **Navigation**: Organized into logical tabs and groups |
| 138 | +- **SEO**: Optimized for search engines |
| 139 | +- **Integrations**: Telemetry and analytics enabled |
| 140 | + |
| 141 | +## 📄 License |
| 142 | + |
| 143 | +This documentation is part of the CodinIT project. See the main project [LICENSE](LICENSE) for details. |
| 144 | + |
| 145 | +## 🌐 Links |
| 146 | + |
| 147 | +- **CodinIT App**: [codinit.dev](https://codinit.dev) |
| 148 | +- **Documentation**: [codinit.dev/docs](https://codinit.dev/docs) |
| 149 | +- **GitHub Repository**: [github.com/Gerome-Elassaad/codinit-app](https://github.com/Gerome-Elassaad/codinit-app) |
| 150 | +- **Download**: [codinit.dev/download](https://codinit.dev/download) |
| 151 | +- **Blog**: [codinit.dev/blog](https://codinit.dev/blog) |
| 152 | + |
| 153 | +## 📞 Support |
| 154 | + |
| 155 | +- **Issues**: [GitHub Issues](https://github.com/Gerome-Elassaad/codinit-app/issues) |
| 156 | +- **Discussions**: [GitHub Discussions](https://github.com/Gerome-Elassaad/codinit-app/discussions) |
| 157 | +- **Community**: Join our Discord community for real-time help |
0 commit comments