Getting Started with Appmint
Appmint is a cloud-based platform consisting of three main services. There's nothing to install - everything runs in the cloud.
Our Cloud Services
1. Vibe Studio
OpenVSCode with custom extensions
- Visual code editor in your browser
- Custom-built agent for assistance
- Deployment helper
- Visual editor for UI design
Access: Visit your Vibe Studio instance URL provided by your administrator
2. Studio Manager
Complete business operating system
- Website builder
- E-commerce platform
- CRM system
- Marketing automation
- Analytics dashboard
Access: Visit your Studio Manager dashboard URL
3. AppEngine
Backend API Service (appengine.appmint.io)
- Data management
- Authentication
- File storage
- AI services
- CRM operations
Access: Via API through your application (never directly from browser)
For Developers: Integrating AppEngine
If you're building an application that uses AppEngine, here's how to connect:
Step 1: Get Your Credentials
Contact your administrator to obtain:
APP_ID
- Your application IDAPP_KEY
- Your application keyAPP_SECRET
- Your application secretORG_ID
- Your organization ID
Step 2: Configure Your Application
Add these to your application's environment variables (.env.local
):
APPENGINE_ENDPOINT=https://appengine.appmint.io
APP_ID=your_app_id
APP_KEY=your_app_key
APP_SECRET=your_app_secret
ORG_ID=your_org_id
SITE_NAME=your_site_name
Step 3: Use the Existing Integration
If you're working with our Next.js template, the integration is already set up:
- Proxy Route:
/api/[...slug]
forwards requests to AppEngine - Client Library:
src/lib/appmint-client.ts
handles authentication - Configuration:
src/lib/appmint-config.ts
manages settings
You don't need to install anything - just configure and use!
For End Users
Accessing Vibe Studio
- Navigate to your Vibe Studio URL
- Log in with your credentials
- Start coding in the browser - no local setup needed
Accessing Studio Manager
- Navigate to your Studio Manager dashboard
- Log in with your credentials
- Start building your business applications
Using Applications Built with Appmint
Simply visit the application URL in your browser. Everything runs in the cloud.
Common Tasks
Connecting to AppEngine from Your Code
// Client-side: Call through the proxy
const response = await fetch('/api/repository/get/users');
const users = await response.json();
// Server-side: Use the AppEngine client
import { getAppEngineClient } from '@/lib/appmint-client';
const client = getAppEngineClient();
const result = await client.processRequest('GET', 'repository/get/users');
Creating a Support Ticket
const response = await fetch('/api/crm/tickets/create', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
subject: 'Need help',
description: 'Issue description'
})
});
Uploading Files
const formData = new FormData();
formData.append('file', fileInput.files[0]);
const response = await fetch('/api/repository/file/upload', {
method: 'POST',
body: formData
});
No Installation Required
Remember:
- Vibe Studio - Runs in your browser
- Studio Manager - Runs in your browser
- AppEngine - Cloud API service accessed via your application
There are no CLI tools to install, no SDKs to download, no Docker containers to run. Everything is already set up in the cloud.
Need Help?
- Documentation: Check the
/docs
folder in your project - API Reference: See
/docs/developers/api-reference.md
- Integration Guide: See
/docs/developers/appengine-integration.md
- Support: Contact your administrator
Browser Requirements
For the best experience with our cloud services:
- Chrome 90+ (recommended)
- Firefox 88+
- Safari 14+
- Edge 90+
Enable JavaScript and cookies for full functionality.
That's it! No installation needed - just configure your credentials and start using Appmint cloud services.