ForVoyez Documentation is a comprehensive guide for using the ForVoyez API, an AI-powered image metadata generation service. This documentation project provides detailed information on API usage, account management, billing, and best practices for integrating ForVoyez into your applications.
- 📚 In-depth API documentation
- 🚀 Quick start guide for new users
- 💻 Code examples in multiple programming languages
- 🔐 Authentication and security best practices
- 📊 Usage tracking and quota management information
- 💳 Billing and subscription management details
- 🧪 Interactive API playground for testing
- 🎨 Responsive and user-friendly design
To run the ForVoyez documentation project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/ForHives/forvoyez-doc.git -
Navigate to the project directory:
cd forvoyez-doc -
Install dependencies:
npm install -
Start the development server:
npm run dev -
Open your browser and visit
http://localhost:3000to view the documentation.
Ensure you have the following installed:
- Node.js (v20.x or higher)
- npm (v10.x or higher)
We welcome contributions to improve the ForVoyez documentation. If you'd like to contribute:
- Fork the repository
- Create a new branch for your feature or bug fix
- Make your changes and commit them with descriptive commit messages
- Push your changes to your fork
- Submit a pull request to the main repository
Please ensure your code adheres to our coding standards and includes appropriate tests.
If you encounter any issues or have questions about the ForVoyez documentation, please:
- Open an issue in this repository for documentation-related problems
- Contact our support team at [email protected] for API-specific inquiries
- Change the numbers in limits-and-quotas.mdx
- Change the pricing in pricing.mdx
- Change the pricing in lemonsqueezy
- Call /api/sync
- Change the pricing/number in the database (for the descriptions)
📚 Comprehensive documentation for ForVoyez - Empowering your AI-powered image metadata generation! 📚