Introduction to AigoTools
AigoTools is an innovative project designed to simplify the creation and management of website directories. This robust tool is equipped with a variety of features that assist users in effortlessly deploying their own navigation sites. Through AigoTools, users can benefit from site management capabilities, automatic site inclusion, internationalization, SEO optimization, and multiple image storage solutions.
Key Features
-
Site Management: AigoTools provides powerful tools for organizing and managing site content, making it easy to keep everything under control.
-
Automatic Site Inclusion: Using advanced technologies like Playwright, Jina, and OpenAI, AigoTools can automatically gather site information, streamlining the setup process.
-
User Management: User management is handled through Clerk, ensuring secure and efficient administration of user data.
-
Internationalization: AigoTools supports multiple languages, broadening the reach of your site to a global audience.
-
Dark/Light Theme Toggle: Users can switch between dark and light themes, enhancing the user experience and accessibility.
-
SEO Optimization: With built-in SEO tools, AigoTools helps improve your site's visibility in search engine results.
-
Multiple Image Storage Solutions: It offers options for image storage, including local MinIO, AWS S3, and Tencent Cloud COS, providing flexibility based on user needs.
Deployment
Deploying AigoTools is straightforward. The project comprises a main navigation site and an inclusion service, and it can be set up on a local machine using Docker Compose or through hosting services like Zeabur.
Prerequisites
- Set up an account at Clerk for user management.
- Obtain an OpenAI API key and a Jina API key for site inclusion.
- Configure MongoDB and Redis databases.
Local Deployment Steps
- Clone the repository from GitHub.
- Configure your environment variables by replicating and modifying the
.env
files. - Start the project using Docker Compose.
Note: For users utilizing MinIO for image storage, it's recommended to initially run the project without authentication settings, configure them afterward, and then restart the project.
Hosting Service Deployment
For users preferring a hosted solution, AigoTools can be deployed quickly on hosting services such as Zeabur.
Development
For those interested in contributing or customizing AigoTools, the development process is clear:
- Clone the repository.
- Install necessary dependencies.
- Configure local environment variables.
- Start the project for development.
Figma Resource
AigoTools is also supported by open-source design resources available on Figma, allowing users to incorporate visually appealing interfaces into their projects.
Contribution and Contact
Community contributions are welcomed, and users can contribute by submitting issues or pull requests on GitHub. For any inquiries, the AigoTools team can be reached through GitHub issues or via email at [email protected].
License
AigoTools is licensed under the Apache License 2.0, ensuring openness and freedom to enhance the project further.