You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,11 @@
1
1
2
2
# AGENTS.md
3
3
4
+
## Package manager
5
+
6
+
All packages and projects in this repo use `pnpm` and not `npm`.
7
+
Howeverer internally (e.g. in `codeInjector`) adminforth still supports both `npm` and `pnpm` style install commands, so users of framework itself can use it with either package manager. But in all dev demo/live demo, plugins, adapters, and documentation, we use `pnpm` as the standard.
8
+
4
9
## General engineering rules
5
10
6
11
Write code as if the system contracts are already defined and trusted.
resourceId: 'aparts', // resourceId is defaulted to table name but you can redefine it like this e.g.
209
+
//diff-add
209
210
// in case of same table names from different data sources
210
211
label: 'Apartments', // label is defaulted to table name but you can change it
211
212
//diff-add
212
213
recordLabel: (r) =>`🏡 ${r.title}`,
213
214
columns: [
214
215
{
215
216
name: 'id',
217
+
//diff-add
216
218
type: AdminForthDataTypes.STRING,
217
219
//diff-add
218
220
label: 'Identifier', // if you wish you can redefine label, defaulted to uppercased name
219
221
showIn: { // show column in filter and in show page
220
-
//diff-add
222
+
//diff-remove
223
+
all:true,
224
+
//diff-add
221
225
list: false,
222
226
//diff-add
223
227
edit: false,
224
228
//diff-add
225
229
create: false,
226
230
},
231
+
//diff-add
227
232
primaryKey: true,
228
233
//diff-add
229
234
fillOnCreate: ({ initialRecord, adminUser }) =>Math.random().toString(36).substring(7), // called during creation to generate content of field, initialRecord is values user entered, adminUser object of user who creates record
230
235
},
231
236
{
232
-
name: 'title',
237
+
name: "title",
238
+
//diff-add
233
239
required: true,
234
-
showIn: { all: true }, // all available options
240
+
showIn: {
241
+
all:true, // all available options
242
+
},
243
+
//diff-add
235
244
type: AdminForthDataTypes.STRING,
236
245
//diff-add
237
246
maxLength: 255, // you can set max length for string fields
[Email adapter base class](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/EmailAdapter.ts#L17)
6
+
7
+
## AWS SES Email Adapter
8
+
9
+
```bash
10
+
pnpm i @adminforth/email-adapter-aws-ses
11
+
```
12
+
13
+
Enables email delivery via [Amazon Simple Email Service (SES)](https://aws.amazon.com/ses/), suitable for high-volume, programmatic email sending.
14
+
15
+
## Mailgun Email Adapter
16
+
17
+
```bash
18
+
pnpm i @adminforth/email-adapter-mailgun
19
+
```
20
+
21
+
Allows sending transactional or marketing emails using [Mailgun](https://www.mailgun.com/), a developer-friendly email service.
pnpm i @adminforth/image-generation-adapter-openai
11
+
```
12
+
13
+
Uses OpenAI image generation models such as DALL·E, `gpt-image-1`, and `gpt-image-1.5` to generate images from text prompts.
14
+
15
+
Up to the winter 2026 OpenAI models are one of the most powerful image generation models available, especially GPT-Image-1.5, which is why we started with them.
16
+
17
+
## Gemini (Nano Banana) Image Generation Adapter
18
+
19
+
```bash
20
+
pnpm i @adminforth/image-generation-adapter-nano-banana
21
+
```
22
+
23
+
Uses the latest `gemini-3.1-flash-image-preview` model for instant image generation with text descriptions.
24
+
25
+
This model is the top of the Nano Banana line as of 2026, combining the speed of the Flash series with the improved detail of version 3.1. The adapter lets you integrate the advanced capabilities of previous models into your interface and generate precise visuals even for specific or complex prompts.
Stores uploaded files in [Amazon S3](https://aws.amazon.com/s3/), providing scalable cloud storage. It can be forked and customized to work with S3-compatible services such as MinIO, Wasabi, or other third-party S3 providers.
14
+
15
+
## Local Storage Adapter
16
+
17
+
```bash
18
+
pnpm i @adminforth/storage-adapter-local
19
+
```
20
+
21
+
Stores files locally on the server filesystem. It is suitable for development or small self-hosted setups, but cloud storage is generally a better production option for reliability and scalability.
0 commit comments