Skip to content

README.md

Latest commit

 

History

History
167 lines (116 loc) · 3.61 KB

README.md

File metadata and controls

167 lines (116 loc) · 3.61 KB
# 📝 Node Blog

<div align="center">

💨 A simple, fast, and easy-to-use blog platform 🚀  
⚠️ *Work in progress — Not production ready yet* 🚧

https://github.com/bs32g1038/node-blog/workflows/Node%20Blog%20CI/badge.svg
https://github.com/bs32g1038/node-blog/workflows/Release%20Docker%20CI/badge.svg
https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg
https://img.shields.io/lgtm/alerts/g/bs32g1038/node-blog.svg?logo=lgtm&logoWidth=18](https://lgtm.com/projects/g/bs32g1038/node-blog/alerts/)
https://img.shields.io/lgtm/grade/javascript/g/bs32g1038/node-blog.svg?logo=lgtm&logoWidth=18](https://lgtm.com/projects/g/bs32g1038/node-blog/context:javascript)
https://codecov.io/gh/bs32g1038/node-blog/branch/master/graph/badge.svg](https://codecov.io/gh/bs32g1038/node-blog)
https://img.shields.io/github/license/bs32g1038/node-blog.svg

</div>

https://github.com/bs32g1038/node-blog/blob/master/docs/images/home.png?raw=true

**🌐 Preview:** https://www.lizc.net

---

## ✨ Features

- 🌙☀ **Themes**: Light & Dark mode  
- 🐐 **REST API** built with Node.js + Express  
- 🚜 **Database**: MongoDB + Mongoose  
- 🔨 **Build system**: Webpack  
- 🍓 **Tech stack**: React, Ant Design, Express, Typescript, ...  
- 🌲 **Next.js** for server-side rendering  
- 📲 **Responsive layout** for mobile  
- ⚙️ **Clean workflow** and maintainable architecture  
- … and more

---

## 📁 Project Structure

ROOT │ ├─ server # Blog backend (Node.js + MongoDB) │ └─ client ├─ web # Frontend UI ├─ admin # Admin UI │ ├─ docker-compose.yml # Docker Compose configuration


---

## ✅ Todo List

- [x] Article tags  
- [x] In-browser article writing  
- [x] Comments  
- [x] Search functionality  
- [x] Mobile web support  
- [x] Light & Dark themes  
- [x] Other improvements ...

---

## 🛠 Development Setup

### 1. Clone repository
```bash
git clone https://github.com/bs32g1038/node-blog.git

2. Install dependencies

cd node-blog
npm install

3. Initialize database with sample data

npm run init:dev:data

4. Start development server

npm run dev

5. Build project

npm run build

🚀 Deployment

The project includes everything needed for deployment: client UI, Dockerfile and docker-compose.yml.

✔ Recommended: Deploy with Docker

  1. Pull the project to your server
  2. Install docker and docker-compose
  3. Build containers: 
    docker-compose build
  4. Start services: 
    docker-compose up -d

Without Docker

  1. Install dependencies: 
    npm install
  2. Start in production mode: 
    npm run start:prod
  3. Ensure MongoDB is installed and running.

📦 Environment Requirements

  • OS: Linux, macOS, or Windows
  • Node.js: v14.x or newer (LTS recommended)
  • Database: MongoDB v5.x or newer

🌍 Browser Support

Edge Firefox Chrome Safari Opera
last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions

⭐ Support

If you find this project helpful, please consider giving it a ⭐ on GitHub.
Your support means a lot!

📄 License

MIT License.


---