https://github.com/jirzykerklaan/tep-cms
A fast, file-based content management system that's perfect for modern, static and dynamic websites.
https://github.com/jirzykerklaan/tep-cms
cms content-management-system ejs file-based-cms flat-file json typescript
Last synced: 2 months ago
JSON representation
A fast, file-based content management system that's perfect for modern, static and dynamic websites.
- Host: GitHub
- URL: https://github.com/jirzykerklaan/tep-cms
- Owner: JirzyKerklaan
- Created: 2025-07-25T20:23:50.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-09-12T10:34:59.000Z (9 months ago)
- Last Synced: 2025-09-12T11:43:24.472Z (9 months ago)
- Topics: cms, content-management-system, ejs, file-based-cms, flat-file, json, typescript
- Language: TypeScript
- Homepage:
- Size: 181 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 📚 Table of Contents
- [Features](#features)
- [Installation](#installation)
- [File Structure](#file-structure)
- [Developer tips](#tips)
[//]: # (- [Suggestions or Issues](#contribute))
📦 Features
- ⚡ **File-based Content** – no DB needed.
- 🧱 **Reusable Blocks** – with a modular `page_builder`.
- 📁 **Organized Assets** – with a modern media library.
- 🎨 **SCSS Styling** – modular, maintainable styles.
- 🧪 **Easy Local Dev** – run with nearly zero setup.
- 🚀 **Lightweight & Fast** – powered by Express & EJS.
- 👥 **Multiple users** – allows the user to have multiple accounts.
- 🕙 **Content scheduler** - plan when a post should be released
- 🔖 **Content versioning** - configurable content versioning of entries
- 🧩 **Headless mode** - use headless mode to implement TEP anywhere
- 🔌 **Plugins** - easy management for a variety of plugins
🛠 Installation
1. Clone the repo and install dependencies:
```bash
npm install
```
2. Copy the example config and customize it:
```bash
cp config.example.ts config.ts
```
3. Run the development server
```bash
npm run dev
```
4. Build for production
```bash
npm run prod
```
File Structure
```bash
tep-cms/
├── content/
│ ├── collections/ # All collections (pages, blogs etc.)
│ ├── globals/ # Global site settings (header, footer settings etc.)
│ ├── navigation/ # Navigation menu's
│ └── schemas/ # Collections & globals schemas
├── core/
│ ├── interfaces/ # Interface exports
│ ├── manager/
│ │ ├── controllers/ # Manager route controllers.
│ │ ├── helpers/ # Manager route helpers.
│ │ └── services/ # Manager controller services.
│ ├── middlewares/ # Global middleware
│ ├── services/ # Route services
│ └── validation/ # Validation system
├── public/
│ ├── assets/
│ │ ├── base/ # Static theme images, icons, etc.
│ │ └── uploads/ # Uploaded images, icons, etc.
│ └── css/ # Compiled SCSS styling
├── src/
│ ├── blocks/ # Page_builder blocks & components
│ ├── plugins/ # Installed plugins
│ ├── requests/ # Request validators
│ ├── routes/ # System routing
│ ├── templates/
│ │ ├── layouts/ # Page layouts
│ │ ├── manager/ # /manager views
│ │ └── views/ # Public views
│ ├── types/ # Package definitions
│ └── utils/ # Utility functions
├── styles/ # SCSS styling
├ config.ts
└ server.ts
```
🧪 Development Tips
- Use version control to track content
- Turn off caching during the development fase
- [error codes](.github/docs/error-codes.md)
[//]: # (
🙋 Suggestions or Issues
)
[//]: # ()
[//]: # (If you find bugs or have suggestions, feel free to open an [issue](https://github.com/JirzyKerklaan/tep-cms/issues/new).)