pxgo/nkc

科创研究院

nkc

Requirements

• Base: Node.js v16.14.0

• Database:

  1. mongoDB v4.4.5
  2. Redis v3.2.100
  3. ElasticSearch v6.0.1

• Image Processing: ImageMagick v7.0.10

• PDF Processing: Ghostscript v9.53.3, QPDF v10.3.2

• video Processing: ffmpeg v4.0.2

Main Frameworks

• Web Framework: Koa
• Template Language: Pug
• ORM: Mongoose

Install

1. install all the requirements
2. clone this repo
3. run npm build in your console
4. run npm run init to initialize data
5. run npm run build-pages-p to compile the page
6. npm start and you are able to access via localhost:1086

How to call an API

• In browser

import {nkcAPI} from 'pages/lib/js/netAPI';
import {sweetError, sweetSuccess} from 'pages/lib/js/sweetAlert';

nkcAPI(`pathToYourTarget`, HTTP_Method, {someParameter:'someValue'})
  .then(sweetSuccess)
  .catch(sweetError)

Future plans

• change the template engine into React,
• isomorphism
• multiple device support(IOS, android, etc)