ForVoyez is a powerful SaaS platform that automatically generates SEO-optimized alternative text, titles, and captions for images using advanced AI technology. Our API processes your images and returns metadata in a customizable JSON format, making it easy to integrate into your existing workflows and boost your search engine rankings.
To get started with ForVoyez, follow these steps:
To run the ForVoyez project locally, ensure you have the following dependencies installed:
To set up the development environment for ForVoyez, follow these steps:
You can use the following Docker command to set up a PostgreSQL database for local development:
docker run --name forvoyez-postgres -e POSTGRES_USER=forvoyez -e POSTGRES_PASSWORD=forvoyez -e POSTGRES_DB=forvoyez -p 5432:5432 -d postgres
If you want to configure your .env file to connect to the database, you can use the following environment variables:
DATABASE_URL="postgresql://forvoyez:forvoyez@localhost:5432/forvoyez"
Then, you can connect to the database using the following command:
git clone https://github.com/For-Hives/ForVoyez.git
cd forvoyez
npm install
or bun install
.env
file based on the .env.example
file and fill in the required environment variables.npm run prisma-migrate
npm run prisma-generate
npm run dev
To test and develop the Lemonsqueezy webhook locally, follow these steps:
.env
file, particularly LEMON_SQUEEZY_WEBHOOK_SECRET
, which should contain your Lemonsqueezy webhook secret key.Go to https://webhook.site/ and copy your unique URL.
Start your local development server by running the following command in the terminal at the root of your project:
npm run dev
or bun dev
This will start your Next.js server, which will listen on http://localhost:3000
by default.
Globally install the @webhooksite/cli
package by running the following command:
npm install -g @webhooksite/cli
This will install the Webhook.site command-line tool, which will allow you to forward webhooks to your local server.
Go to the Lemonsqueezy account settings and configure the webhook URL to point to the unique URL provided by Webhook.site.
Run the following command to forward webhooks to your local server:
whcli forward --token=<your-token> --target=http://localhost:3000
Replace <your-token>
with the token provided by Webhook.site. This command will forward the received webhooks from Webhook.site to your local /api/webhook
endpoint.
Configure the webhook URL in your Lemonsqueezy account settings to point to the unique URL provided by Webhook.site.
Perform an action in Lemonsqueezy that will trigger a webhook (e.g., a test payment).
Check your development server logs. You should see the details of the received webhook, indicating that your local endpoint has successfully processed the request.
you can use ngrok to create a secure tunnel to your local server and receive webhooks from Lemonsqueezy. Follow these steps:
npm run dev
or bun dev
This will start your Next.js server, which will listen on http://localhost:3000
by default.ngrok http --domain=[yourdomain] 3000
This command will create a secure tunnel to your local server, and you will receive a unique URL that you can use to forward webhooks to your local server.
If you encounter errors related to HTTPS when forwarding webhooks to your local server, make sure to use http://
instead of https://
in the target URL.
If your local server is not responding, verify that it is running and listening on the correct port (by default, 3000
for Next.js). You can also check the server logs for any relevant error messages.
ForVoyez leverages the power of OpenAI's advanced language models to generate image metadata. The process involves the following steps:
ForVoyez continuously improves its metadata generation capabilities by fine-tuning the language models on a diverse dataset of image-metadata pairs.
Users can monitor their API usage and quota limits directly through the ForVoyez web interface. The dashboard provides detailed statistics and charts showing the number of API calls made, credits consumed, and remaining quota for the current billing period.
If you encounter any bugs, have feature requests, or want to contribute to the project, please email us at support@forvoyez.com. Our team will assist you and provide guidance on how to report issues or submit pull requests.
To use the ForVoyez API, send a POST request to the /api/describe
endpoint with the following parameters:
image
: The image file to process (JPEG, PNG, WebP, GIF).context
(optional): Additional context or information about the image to guide the metadata generation process.jsonSchema
(optional): A custom JSON schema defining the desired output format for the generated metadata.Example Request:
curl -X POST -H "Authorization: Bearer <YOUR_API_TOKEN>" -F "image=@/path/to/image.jpg" -F "context=A beautiful sunset over the ocean" -F "jsonSchema={\"title\": \"string\", \"alt\": \"string\", \"caption\": \"string\"}" https://api.forvoyez.com/describe
Example Response:
{
"title": "Serene Sunset Over the Calm Ocean Waves",
"alt": "A breathtaking sunset with vibrant orange and pink hues reflected on the tranquil ocean surface, creating a peaceful and mesmerizing seascape.",
"caption": "Witness the enchanting beauty of a serene sunset over the calm ocean waves, as the vibrant colors paint the sky and the gentle breeze carries the salty scent of the sea."
}
To run the ForVoyez project, you need to set up the environment variables in a .env
file.
You must follow the .env.example
file to define the required variables.
Make sure to replace the placeholders with your actual values for each environment variable.
If you encounter any issues, have questions, or need assistance, please don't hesitate to reach out to our support team at support@forvoyez.com or visit our contact page.
๐ Boost your image SEO with ForVoyez - the ultimate AI-powered image metadata generation solution! ๐