Skip to content

Commit 97ec688

Browse files
committed
chore: readme and .env.example for easy email
1 parent ac1bfa3 commit 97ec688

File tree

4 files changed

+66
-11
lines changed

4 files changed

+66
-11
lines changed

apps/cms/.env.example

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ NEXT_PUBLIC_SERVER_URL=http://localhost:3000
1010
# Storefront configuration
1111
NEXT_PUBLIC_STOREFRONT_URL=http://localhost:3020
1212

13+
# Easy Email configuration
14+
NEXT_PUBLIC_EASY_EMAIL_URL=http://localhost:3040
15+
1316
# CJ Dropshipping API credentials
1417
# Your email address used for CJ Dropshipping login
1518
CJ_EMAIL_ADDRESS=your-email@example.com

apps/cms/src/plugins.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,16 @@ export const plugins: Plugin[] = [
6161
},
6262
},
6363
}),
64+
easyEmailPlugin({
65+
collectionOverrides: {
66+
access: {
67+
create: adminPluginAccess,
68+
delete: adminPluginAccess,
69+
read: adminPluginAccess,
70+
update: adminPluginAccess,
71+
},
72+
},
73+
}),
6474
quickActionsPlugin({
6575
position: "before-nav-links",
6676
}),
@@ -80,14 +90,4 @@ export const plugins: Plugin[] = [
8090
return resultFields;
8191
},
8292
}),
83-
easyEmailPlugin({
84-
collectionOverrides: {
85-
access: {
86-
create: adminPluginAccess,
87-
delete: adminPluginAccess,
88-
read: adminPluginAccess,
89-
update: adminPluginAccess,
90-
},
91-
},
92-
}),
9393
];

apps/shopnex-email/.env.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
NEXT_PUBLIC_SERVER_URL=http://localhost:3000

apps/shopnex-email/README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,58 @@
1+
# Easy Email App
2+
3+
**Easy Email** is a lightweight email app designed to run entirely on the client side. It can be deployed separately, for example on Cloudflare Pages or any static hosting, and embedded anywhere via an `<iframe>`.
4+
5+
This makes it perfect for integrating into existing platforms or dashboards without requiring a backend.
6+
7+
> ⚠️ Note: This app cannot work with SQLite. Make sure your environment uses a supported database if needed.
8+
9+
---
10+
11+
## Features
12+
13+
- Runs entirely client-side — no server required
14+
- Easy to embed in any application via `<iframe>`
15+
- Simple setup and deployment
16+
- Fully configurable via environment variables
17+
18+
---
19+
120
## Getting Started
221

22+
1. **Install dependencies**
23+
24+
```bash
25+
pnpm --ignore-workspace install
26+
```
27+
28+
2. **Configure environment variables**
29+
30+
Copy the example file and fill in the required values:
31+
332
```bash
4-
pnpm install
33+
cp .env.example .env
34+
```
535

36+
3. **Start the development server**
37+
38+
```bash
639
pnpm dev
740
```
41+
42+
Your app will now be running locally, ready to test and embed.
43+
44+
---
45+
46+
## Deployment
47+
48+
Since this is a client-only app, you can deploy it to any static hosting service:
49+
50+
- **Cloudflare Pages**
51+
- **Vercel**
52+
- **Netlify**
53+
54+
Simply build the project and serve the generated static files:
55+
56+
```bash
57+
pnpm build
58+
```

0 commit comments

Comments
 (0)