Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,7 @@ UNIFORM_PREVIEW_SECRET=hello-world
# defaults to localhost:3000 if not set.
#When set, should resolve to the base url of the app.
# This is used to generate the sitemap and robots.txt
BASE_URL=
BASE_URL=

# Temporarily, you need to provide an NPM token to download the new SDK alpha packages.
NPM_TOKEN=
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Run `npx @uniformdev/cli new` and pick `Next.js` -> `Component Starter Kit` from
> Make sure your API key has "Developer" role to be able to push content.
1. `npm install` to install dependencies
1. Run `npm run init` to initialize your project.
> This will push all content from disk (`.\content` folder) and your design settings (colors, fonts, borders, etc. for this default theme).
> This command uses `@uniformdev/csk-cli` to push all content from disk (`./content` folder), design settings (colors, fonts, borders, etc.), and publish the context manifest. If CSK variants are available, you'll be prompted to select which one to initialize.

### Step 2. Run locally in dev mode

Expand All @@ -66,7 +66,16 @@ This integration brings new parameter types for design and layout control via Un

The following scripts are created to facilitate sync of content between the `./content` folder and your project.

1. Run `npm run push:content` to push data from disk (see `./content`) to your Uniformproject.
### Complete Project Sync

1. Run `npm run init` to initialize/push everything (content, design extensions, and context manifest) to your Uniform project.
2. Run `npm run uniform:pull` to pull everything (content and design extensions) from your Uniform project to disk.

These commands use `@uniformdev/csk-cli` and handle the complete synchronization workflow. If CSK variants are available, you'll be prompted to select which one to sync.

### Granular Content Sync

1. Run `npm run push:content` to push data from disk (see `./content`) to your Uniform project.
1. Run `npm run pull:content` to pull data from your Uniform project to `./content` folder.

Alternatively you can use `npm run pull:content:dev` and `npm run push:content:dev` to pull and push developer-owned content to your local project. The scope of the developer-owned content is defined in the `uniform.config.dev.ts` file.
Expand All @@ -83,6 +92,7 @@ Whenever you add new **colors, dimensions, fonts, or borders**, your application

```sh
npm run pull:dex
npm run apply:dex
```

This command is automatically executed when running:
Expand All @@ -105,16 +115,10 @@ When modifying an **existing value**, your app will automatically fetch the upda

## 🎨 Working with Styles

If you prefer managing styles manually, you can modify the predefined configuration files located in the `styles/` directory:

- `styles/border.css`
- `styles/colors.css`
- `styles/dimensions.css`
- `styles/fonts.css`

After making changes, push the updated configuration using:
If you prefer managing styles manually, you can modify the predefined configuration files `dex.config.json`. After making changes, apply and push the updated configuration using:

```sh
npm run apply:dex
npm run push:dex
```

Expand Down Expand Up @@ -143,16 +147,16 @@ By default, the **Design Extension** includes two predefined groups:
- `button`
- `text`

### **Understanding `allowGroups.json`**
### **Understanding `allowGroups`**

When your project is still using the default configuration, the `allowGroups.json` file will be **empty**. However, if you add a custom group (e.g., `page`), it will be added to this file automatically.
When your project is still using the default configuration, the `allowGroups` field will be **empty**. However, if you add a custom group (e.g., `page`), it will be added to this field automatically.

#### **Example: Adding a Custom Group (Page)**

If you introduce a new group, such as `page`, the `allowGroups.json` file will be updated as follows:
If you introduce a new group, such as `page`, the `dex.config.json` file will be updated as follows:

```json
{ "color": ["button", "page", "text"] }
allowedGroups: { "color": ["button", "page", "text"] }
```

### **Creating and Pushing Custom Groups**
Expand Down
116 changes: 0 additions & 116 deletions content/compositionPattern/f9c058ea-c40d-4435-ac5a-53423cf654dc.yaml

This file was deleted.

30 changes: 30 additions & 0 deletions content/core/asset/486077aa-19ad-4bc8-9310-eccf34b48aa4.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
asset:
type: image
_id: 486077aa-19ad-4bc8-9310-eccf34b48aa4
_name: ''
fields:
title:
type: text
value: rectangle_light.png
file:
type: file
value: 4fbbd08c-6f27-48ab-9d9a-4bbc665c96c8
mediaType:
value: image/png
type: text
url:
value: >-
https://img.uniform.global/p/gaaGBo44T8KlqJ3IGMZtAQ/Ze4bptBxSsypS_AB5rQ7ng-rectangle_light.png
type: text
size:
value: 1350631
type: number
width:
value: 1536
type: number
height:
value: 1024
type: number
custom: {}
created: '2025-10-14T07:24:25.366227+00:00'
modified: '2025-10-14T07:24:25.366227+00:00'
Loading