Giter Club home page Giter Club logo

blog's Introduction

Node Blog GJzhou

💨 A simple, fast and easy-to-use blog 🚀

⚠️ Caution: Working in progress - It's not production ready 🚧

Actions Status Actions Status Coverage Status GitHub

博客首页

Features

  • 🌙☀ Theme: Support light and dark themes
  • 🐐 APi: Node-blog through Nodejs and express provide the Restful API
  • 🚜 Database: Data stored in Mongodb,Driven by Mongoose
  • 🔨 Powerful build: Use powerful webpack to build projects
  • 🍓 Framework support: React, Ant design, Express, Typescript, ...
  • 🌲 Nextjs: Support server-side render
  • 📲 Responsive: Responsive layout for mobile-side
  • ⚙️ Best Practices: Solid workflow to make your code healthy
  • ......

Structure

ROOT
│
├─server // provide blog server api, based one nodejs, mongodb
│
client // client ui
│
├──web // front-end ui
│
├──admin // admin ui
│
├─docker-compose.yml // docker-compose config file

Todo

  • Article tags
  • Writing new article in browser
  • Comments
  • Search support
  • Mobile web support
  • Light theme & Dark theme
  • Article draft record
  • Other support ...

Development

1,clone code

git clone https://github.com/bs32g1038/node-blog.git

2,install

cd **
npm install

3,init database data

// this will generate the faker data to database
npm run init:dev:data

4,run app

npm run dev     // development mode

4, build dist

npm run build   // build dist for server and client

Deploy

The project has integrated related suites, such as client ui, dockerfile, docker-compose.yml. So you can easy to deploy the project.

  • First: I recommend that you debug locally and make changes to configuration information, such as database information and personal information.
  • Secondly: you can choice the docker to deploy this project. It is very esay. you only pull the project to your server and install docker, and run docker-compose build command, and run docker-compose up -d command

However!!!⚠

If you don't want to use docker, you must to cd the current item and run npm install or yarn install command.

At the same time, when finish install, you need to run npm run start:prod command.

Besides, you may need to install mongodb,before you run the application.

Environment dependence

Operating System: Linux, OS X or Windows.

Node.js Runtime: 20.x or newer; it is recommended that you use LTS Releases.

database: mongdb 5.x or newer;

Browsers support

Modern browsers.

<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" /></br>Edge <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" /></br>Firefox <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" /></br>Chrome <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" /></br>Safari <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" /></br>Opera
Edge last 2 versions last 2 versions last 2 versions last 2 versions

Thank you:

If you think these contents are useful to you, please add a "Star" at the top right. This is the encouragement to me, thank you!

License

MIT

blog's People

Contributors

bs32g1038 avatar dependabot-preview[bot] avatar dependabot[bot] avatar gongjinzhou avatar elgohr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.