https://github.com/ujarhr/simpleblog-cms
A markdown-based CMS with a built-in editor, tagging system, minimal UI, and support for easy content publishing.
https://github.com/ujarhr/simpleblog-cms
blog-cms cms-backend koajs mini-cms simpleblog-cms typescript-project
Last synced: about 1 month ago
JSON representation
A markdown-based CMS with a built-in editor, tagging system, minimal UI, and support for easy content publishing.
- Host: GitHub
- URL: https://github.com/ujarhr/simpleblog-cms
- Owner: ujaRHR
- License: mit
- Created: 2025-07-26T12:19:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-26T16:32:26.000Z (11 months ago)
- Last Synced: 2025-07-26T21:27:16.870Z (11 months ago)
- Topics: blog-cms, cms-backend, koajs, mini-cms, simpleblog-cms, typescript-project
- Language: TypeScript
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
📑 SimpleBlog CMS
SimpleBlog CMS is a headless Content Management System (CMS) for a simple blog application. It provides a RESTful API for managing users, posts, and comments.
## Features
- User Authentication: Secure user registration and login using JSON Web Tokens (JWT).
- Post Management: Full CRUD (Create, Read, Update, Delete) functionality for blog posts.
- Comment System: Users can add comments and replies to posts. Full CRUD on comments is also supported.
- Markdown to HTML: Automatically converts post content from Markdown to HTML.
- Password Hashing: Securely hashes user passwords before storing them in the database.
- Environment-based Configuration: Easy setup using environment variables.
## Tech Stack
- Backend: Node.js, Koa.js
- Database: PostgreSQL with Sequelize ORM
- Language: TypeScript
- Authentication: JSON Web Tokens (JWT), bcrypt.js for hashing
- Content: `marked` for Markdown to HTML conversion and `DomPurify` for converted HTML sanitization.
- Emailing: `nodemailer` for sending emails (email verification, password resets).
## Structure
```
/src
├── /config # Environment variables and configuration
├── /controllers # Request handlers and business logic
├── /middleware # Koa middleware (e.g., auth)
├── /models # Sequelize schemas and models
├── /routes # API route definitions
├── /utils # Utility functions
└── app.ts # Application entry point
```
## System Architecture Overview
```mermaid
sequenceDiagram
participant Client
participant API as "API (Koa.js)"
participant DB as "DB (PostgreSQL)"
Client->>API: POST /api/auth/register (name, email, password)
API->>API: Hash password (e.g., bcrypt)
API->>DB: INSERT INTO users (...)
DB-->>API: Return created user row
API->>API: Generate JWT
API-->>Client: Respond with User Info & JWT
Client->>API: POST /api/auth/login (email, password)
API->>DB: SELECT * FROM users WHERE email = ?
DB-->>API: Return user row (with hashed password)
API->>API: Compare provided password with stored hash
alt Passwords Match
API->>API: Generate JWT
API-->>Client: Respond with JWT
else Passwords Do Not Match
API-->>Client: Respond with 401 Unauthorized
end
Client->>API: GET /api/posts (Authorization: Bearer JWT)
API->>API: Verify JWT
alt JWT is Valid
API->>DB: SELECT * FROM posts
DB-->>API: Return post rows
API-->>Client: Respond with posts data
else JWT is Invalid
API-->>Client: Respond with 401 Unauthorized
end
```
## Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
#### Prerequisites
- Node.js (v20+ recommended)
- PostgreSQL is installed and running.
#### Installation
1. Clone the repository:
```
git clone https://github.com/ujarhr/simpleblog-cms.git
cd simpleblog-cms
```
2. Install dependencies:
```
pnpm install
```
3. Set up environment variables:
Create a `.env` file in the root of the project by copying the example file:
```
cp .env.example .env
```
4. Now, open the `.env` file and fill in the required values:
```
ENV=development
PORT=3000
JWT_SECRET=A_Long_Random_Secret
# Project Info
PROJECT_NAME=SimpleBlog CMS
PROJECT_EMAIL=hello@rhraju.com
# Database Configurations
DB_TYPE=postgres
DB_HOST=127.0.0.1
DB_PORT=5432
DB_USER=root
DB_PASS=password
DB_NAME=simpleblog
# SMTP Configurations
SMTP_HOST=smtp.ethereal.email
SMTP_PORT=587
SMTP_USER=demo@ethereal.email
SMTP_PASS=Your_Ethereal_Password
```
5. Running the Application:
```
pnpm run dev
```
#### Overall Project Details -> [Markdown Note-taking App](https://roadmap.sh/projects/markdown-note-taking-app)
## License
This project is licensed under the MIT License - see the LICENSE file for details.