@plank-cms/plank 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +28 -0
- package/README.md +34 -0
- package/dist/admin/assets/hls-0EiSYoTw.js +40 -0
- package/dist/admin/assets/index-BCd-a4uR.css +2 -0
- package/dist/admin/assets/index-Db1a-6aD.js +203 -0
- package/dist/admin/favicon.png +0 -0
- package/dist/admin/index.html +21 -0
- package/dist/admin/particles-texture.png +0 -0
- package/dist/admin/plank-logo-w.svg +4 -0
- package/dist/index.js +177 -0
- package/dist/migrations/001_plank_roles.sql +5 -0
- package/dist/migrations/002_plank_users.sql +7 -0
- package/dist/migrations/003_plank_content_types.sql +9 -0
- package/dist/migrations/004_plank_api_tokens.sql +7 -0
- package/dist/migrations/005_plank_media.sql +10 -0
- package/dist/migrations/006_plank_users_name.sql +3 -0
- package/dist/migrations/007_api_tokens_access_type.sql +2 -0
- package/dist/migrations/008_content_types_default.sql +2 -0
- package/dist/migrations/009_plank_settings.sql +7 -0
- package/dist/migrations/010_users_avatar.sql +1 -0
- package/dist/migrations/011_entries_status.sql +17 -0
- package/dist/migrations/012_entries_published_data.sql +14 -0
- package/dist/migrations/013_entries_published_at.sql +14 -0
- package/dist/migrations/014_timezone_setting.sql +3 -0
- package/dist/migrations/015_entries_scheduled.sql +14 -0
- package/dist/migrations/016_entries_created_by.sql +14 -0
- package/dist/migrations/017_content_types_kind.sql +2 -0
- package/dist/migrations/018_plank_webhooks.sql +8 -0
- package/dist/migrations/019_user_prefs.sql +7 -0
- package/dist/migrations/020_plank_media_folders.sql +8 -0
- package/dist/migrations/021_users_profile_fields.sql +4 -0
- package/dist/migrations/022_plank_media_metadata.sql +4 -0
- package/dist/migrations/023_entries_localized.sql +17 -0
- package/dist/server-VPVKRT67.js +2742 -0
- package/package.json +67 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
Copyright (c) 2026 AM25, S.A.S. DE C.V.
|
|
2
|
+
|
|
3
|
+
MIT License
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is furnished
|
|
10
|
+
to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
Additional Notice
|
|
26
|
+
|
|
27
|
+
This project may include additional commercial or enterprise components in the future,
|
|
28
|
+
which will be licensed separately under different terms by AM25, S.A.S. DE C.V.
|
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Plank CMS
|
|
2
|
+
|
|
3
|
+
A self-hosted headless CMS you can deploy in minutes. Built on Node.js and PostgreSQL — runs entirely on your infrastructure.
|
|
4
|
+
|
|
5
|
+
## Quick start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @am25/plank-cms init .
|
|
9
|
+
npm start
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
The admin panel will be available at `http://localhost:5500/admin`.
|
|
13
|
+
|
|
14
|
+
## What it is
|
|
15
|
+
|
|
16
|
+
Plank is a headless CMS that runs as a standalone Express server and exposes a REST API for consuming content from any frontend. Content types and fields are defined visually from the admin panel — no code changes, no restarts.
|
|
17
|
+
|
|
18
|
+
The API is token-authenticated. Tokens are managed from the admin panel and can be scoped to read-only or full access.
|
|
19
|
+
|
|
20
|
+
## Architecture
|
|
21
|
+
|
|
22
|
+
- **Server** — Express 5, REST API, JWT auth, role-based access control
|
|
23
|
+
- **Database** — PostgreSQL via `pg` (no ORM). Each content type maps to a real table; schema changes run as live `ALTER TABLE` statements
|
|
24
|
+
- **Admin panel** — React + Vite, served as static files by the same Express process in production
|
|
25
|
+
- **Media** — provider pattern with support for local storage, AWS S3, and Cloudflare R2
|
|
26
|
+
|
|
27
|
+
## Requirements
|
|
28
|
+
|
|
29
|
+
- Node.js 20+
|
|
30
|
+
- PostgreSQL 18
|
|
31
|
+
|
|
32
|
+
## License
|
|
33
|
+
|
|
34
|
+
[MIT](LICENSE) — AM25, S.A.S. DE C.V.
|