Ycode

https://docs.ycode.com/docs
Admin
Ycode is a visual website builder with drag-and-drop editor, built-in CMS, forms, localization, and...
Tokens:26,328
Snippets:480
Trust Score:9.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start Development Server

Source: https://docs.ycode.com/docs/getting-started/installation

Start the local development server for Ycode.

```bash
npm run dev
```

--------------------------------

### Install Dependencies

Source: https://docs.ycode.com/docs/getting-started/installation

Install the necessary Node.js dependencies for Ycode.

```bash
npm install
```

--------------------------------

### Supabase Connection String Example

Source: https://docs.ycode.com/docs/getting-started/configuration

Example of a Supabase PostgreSQL connection string using the Transaction Pooler. Ensure to replace placeholders with your actual project details.

```sql
postgresql://postgres.[PROJECT-ID]:[PASSWORD]@aws-x-xx-xxxx-x.pooler.supabase.com:6543/postgres
```

--------------------------------

### Copy Environment File

Source: https://docs.ycode.com/docs/getting-started/installation

Copy the example environment file to create your own .env file for local configuration.

```bash
cp .env.example .env
```

--------------------------------

### Create Item Request (cURL)

Source: https://docs.ycode.com/docs/api-reference

Example cURL request to create a new blog post item. The 'id', 'created_at', and 'updated_at' fields are auto-generated.

```bash
curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "New Blog Post", "slug": "new-blog-post", "content": "Hello world"}' \
  "https://your-project.ycode.dev/ycode/api/v1/collections/:id/items"
```

--------------------------------

### Image Optimization Example

Source: https://docs.ycode.com/docs/assets

Append query parameters to an asset's public URL to control its dimensions and quality. This is useful for responsive images and improving page load performance.

```url
https://your-project.supabase.co/storage/v1/object/public/assets/image.jpg?width=800&quality=80
```

--------------------------------

### Example Webhook Payload for form.submitted

Source: https://docs.ycode.com/docs/integrations/webhooks

This is an example of the JSON payload structure for a 'form.submitted' event. It includes event type, timestamp, and specific data related to the form submission.

```json
{
  "event": "form.submitted",
  "timestamp": "2025-02-16T12:00:00.000Z",
  "data": {
    "form_id": "abc123",
    "submission_id": "xyz789",
    "fields": {
      "email": "user@example.com",
      "name": "Jane Doe"
    }
  }
}
```

--------------------------------

### Response Format Example

Source: https://docs.ycode.com/docs/api-reference

Successful responses for list endpoints include JSON data and pagination metadata. Single-resource endpoints return the resource directly.

```json
{
  "items": [...],
  "pagination": {
    "total": 42,
    "page": 1,
    "per_page": 100
  }
}
```

--------------------------------

### Get Form

Source: https://docs.ycode.com/docs/api-reference

Retrieves a single form by its ID, including its field definitions.

```HTTP
GET /ycode/api/v1/forms/:id
```

--------------------------------

### List Items with Filtering and Sorting (cURL)

Source: https://docs.ycode.com/docs/api-reference

Example cURL request demonstrating how to list items with sorting by name in descending order, filtering by status 'active', and setting items per page to 50.

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://your-project.ycode.dev/ycode/api/v1/collections/:id/items?sort_by=name&order_by=desc&filter[status]=active&per_page=50"
```

--------------------------------

### Update Item (Full) Request (cURL)

Source: https://docs.ycode.com/docs/api-reference

Example cURL request to perform a full update on an item. The 'id', 'created_at', and 'updated_at' fields are protected and cannot be overwritten. 'updated_at' is set automatically.

```bash
curl -X PUT \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Title", "slug": "updated-title", "content": "New content"}' \
  "https://your-project.ycode.dev/ycode/api/v1/collections/:id/items/:itemId"
```

--------------------------------

### Get Form

Source: https://docs.ycode.com/docs/api-reference

Retrieves a single form by its ID, including its field definitions.

```APIDOC
## GET /ycode/api/v1/forms/:id

### Description
Returns a single form by ID, including field definitions.

### Method
GET

### Endpoint
/ycode/api/v1/forms/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the form to retrieve.

### Response
#### Success Response (200)
- **(object)** - The form object, including its field definitions.

### Response Example
```json
{
  "id": "form-uuid",
  "name": "Contact Us",
  "fields": [
    { "name": "email", "type": "email" },
    { "name": "message", "type": "textarea" }
  ]
}
```
```

--------------------------------

### Generate CSS Class for Custom Font

Source: https://docs.ycode.com/docs/editor/fonts

This example shows the CSS class generated for a custom font like 'Open Sans'. It uses arbitrary value syntax compatible with Tailwind CSS.

```css
/* Example: Open Sans generates */
.font-\[Open_Sans\] {
  font-family: "Open Sans", sans-serif;
}
```

--------------------------------

### Error Response Example

Source: https://docs.ycode.com/docs/api-reference

Errors return appropriate HTTP status codes with a JSON body detailing the error code and message.

```json
{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource was not found."
  }
}
```

--------------------------------

### Get Item

Source: https://docs.ycode.com/docs/api-reference

Retrieves a single item from a collection by its ID.

```APIDOC
## GET /collections/:id/items/:itemId

### Description
Returns a single collection item by ID.

### Method
GET

### Endpoint
/ycode/api/v1/collections/:id/items/:itemId
```

--------------------------------

### Get Submission

Source: https://docs.ycode.com/docs/api-reference

Retrieves a single form submission by its ID.

```HTTP
GET /ycode/api/v1/forms/:id/submissions/:submissionId
```

--------------------------------

### Get Submission

Source: https://docs.ycode.com/docs/api-reference

Retrieves a single submission for a specific form by its submission ID.

```APIDOC
## GET /ycode/api/v1/forms/:id/submissions/:submissionId

### Description
Returns a single submission by ID.

### Method
GET

### Endpoint
/ycode/api/v1/forms/:id/submissions/:submissionId

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the form.
- **submissionId** (string) - Required - The ID of the submission to retrieve.

### Response
#### Success Response (200)
- **(object)** - The submission object.

### Response Example
```json
{
  "submissionId": "sub-uuid",
  "data": {
    "email": "test@example.com",
    "message": "Hello"
  }
}
```
```

--------------------------------

### Run Static HTML Export from CLI

Source: https://docs.ycode.com/docs/integrations/apps/static-export

Use this command to run the static HTML export process from your command line. This is useful for automated deployments, CI pipelines, or scheduled exports.

```bash
npx tsx --env-file=.env scripts/export.ts
```

--------------------------------

### Get Collection

Source: https://docs.ycode.com/docs/api-reference

Retrieves a single collection by its ID, including its field definitions.

```APIDOC
## GET /collections/:id

### Description
Returns a single collection by ID, including field definitions.

### Method
GET

### Endpoint
/ycode/api/v1/collections/:id
```

--------------------------------

### Clone Ycode Repository

Source: https://docs.ycode.com/docs/getting-started/installation

Clone the Ycode repository to your local machine to begin local development.

```bash
git clone https://github.com/ycode/ycode.git
cd ycode
```

--------------------------------

### List Forms

Source: https://docs.ycode.com/docs/api-reference

Lists all forms available in the project.

```APIDOC
## GET /ycode/api/v1/forms

### Description
Returns all forms in the project.

### Method
GET

### Endpoint
/ycode/api/v1/forms

### Response
#### Success Response (200)
- **(array)** - A list of form objects.

### Response Example
```json
[
  {
    "id": "form-uuid-1",
    "name": "Contact Us"
  },
  {
    "id": "form-uuid-2",
    "name": "Feedback"
  }
]
```
```

--------------------------------

### Get Collection Endpoint

Source: https://docs.ycode.com/docs/api-reference

Retrieve a single collection by its ID. This includes the collection's field definitions.

```http
GET /ycode/api/v1/collections/:id
```

--------------------------------

### List Forms

Source: https://docs.ycode.com/docs/api-reference

Retrieves a list of all forms within the project.

```HTTP
GET /ycode/api/v1/forms
```

--------------------------------

### Get Item Endpoint

Source: https://docs.ycode.com/docs/api-reference

Retrieve a single item from a collection using its collection ID and item ID.

```http
GET /ycode/api/v1/collections/:id/items/:itemId
```

--------------------------------

### Ycode Database Migration Commands

Source: https://docs.ycode.com/docs/getting-started/configuration

CLI commands for managing Ycode database migrations. Use these to apply, check status, or rollback migrations manually.

```bash
# Run all pending migrations
npm run migrate:latest

# Check migration status
npm run migrate:status

# Rollback the last migration
npm run migrate:rollback
```

--------------------------------

### Set Google Maps API Key via Environment Variable

Source: https://docs.ycode.com/docs/integrations/apps/google-maps

Provide the Google Maps Embed API key using the GOOGLE_MAPS_EMBED_API_KEY environment variable. This is useful for self-hosted deployments.

```bash
GOOGLE_MAPS_EMBED_API_KEY=AIzaSy...
```

--------------------------------

### Mapbox Access Token Environment Variable

Source: https://docs.ycode.com/docs/integrations/apps/mapbox

Provide your Mapbox access token via the MAPBOX_ACCESS_TOKEN environment variable for self-hosted deployments. This ensures the integration is connected and the token cannot be changed via the UI.

```bash
MAPBOX_ACCESS_TOKEN=pk.eyJ1Ijo...
```

--------------------------------

### Create Item

Source: https://docs.ycode.com/docs/api-reference

Creates a new item within a specified collection. The item is created as published immediately.

```APIDOC
## POST /collections/:id/items

### Description
Creates a new item in the collection. The item is created as published immediately.

### Method
POST

### Endpoint
/ycode/api/v1/collections/:id/items

### Request Body
Send a JSON body with field slugs as keys and their values:
```json
{
  "name": "New Blog Post",
  "slug": "new-blog-post",
  "content": "Hello world"
}
```

### Request Example
```
curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "New Blog Post", "slug": "new-blog-post", "content": "Hello world"}' \
  "https://your-project.ycode.dev/ycode/api/v1/collections/:id/items"
```

### Response
#### Success Response (201)
Returns the created item.

The `id`, `created_at`, and `updated_at` fields are generated automatically and cannot be set manually.
```

--------------------------------

### List Collections

Source: https://docs.ycode.com/docs/api-reference

Retrieves a list of all collections available in the project.

```APIDOC
## GET /collections

### Description
Returns all collections in the project.

### Method
GET

### Endpoint
/ycode/api/v1/collections
```

--------------------------------

### Restart Docker Containers

Source: https://docs.ycode.com/docs/getting-started/configuration

Command to restart Docker containers after modifying the .env file for self-hosted Supabase. This ensures the changes are applied.

```bash
docker compose down && docker compose up -d
```
Tokens:
Raw