lzszone / nkc

科创研究院

nkc

Requirements

• Base: Node.js

  v7.6+ is required, for async function
  

• Database: mongoDB v3.4

  higher version may not be compatible with current state, we're on our way, PR is welcome
  

• Image Processing: ImageMagick v7.0 or higher

• Search: ElasticSearch 6 with IK Analysis for Elasticsearch

Main Frameworks

• Web Framework: Koa
• Template Language: pug
• ORM: mongoose v4.*, v5.* may not be compatible.

Install

1. install all the requirements
2. clone this repo
3. run npm install in your console
4. npm start and you are able to access via localhost:1086

How to call an API

• In browser

<script src='/interface_common.js'/>
<script>
  nkcAPI(`pathToYourTarget`, HTTP_Method, {someParameter:'someValue'})
    .then(jalert)
    .catch(jalert)
</script>

Future plans

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