Volatile

The repository is currently in a volatile state(deadline approaching). Don't pull from it before July...

nkc2

nkc community project, version 2. Currently under dev.

Recruitment

Join our company. We expect applicants:

1. Have good understanding of Promise in JavaScript.
2. Have no problem reading ArangoDB's documentation.
3. Can read/ write/ speak Chinese fluently.

License

You are allowed to use these files for any purpose, as long as you admit that they are useful[1]. The author of these files shall not be held responsible for any terrorist attacks or global climate changes caused by the use of these files.

[1] Before we change our mind.

Reading list

• Framework: Express 4 (if you want to implement framework level features)
• Template Language: Jade (now called Pug. Best template language, ever)
• Database: ArangoDB (best of NoSQL)
• Image Processing: ImageMagick (one and only)
• Frontend Framework: Raw JavaScript + React (Admin Panel), need Promise support in browser (Does not support IE before Polyfilling)

Security Updates

• 20160514: ImageMagick was found to contain security exploits that provides remote execution capabilities to hackers. Make sure you are using the latest version of ImageMagick (7.0.1-3 as for now), otherwise please do upgrade immediately.

Recommended way to install dependencies

• ImageMagick

  • Windows

    Official Site Download.

  • OS X

    brew install ImageMagick

  • CentOS

    check scripts directory.

• ArangoDB

  • Windows

    Installer.

  • OSX

    Installer. run ArangoDB-CLI.app directly from Applications.

  • CentOS

    check scripts directory. Change the version number when necessary.

How to implement an API

We are currently refactoring. To help, read the following carefully.

1. (If the API is for data modification/retrieval) Visit localhost:8529. Learn AQL basics from ArangoDB Official Documentation. Write AQL. Test to see if your query works.
2. Implement the API function in JavaScript. Please refer to nkc_modules/api_operations/example.js.
3. Make sure the current user has 'dev' certificate (can call every API once implemented). To allow users with other certificates to call that API, Modify permissions.js.
4. Reload Server.

How to call an API

• In browser

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

• In general

  An HTTP request should be made with cookies (for User Authentication) to /api/operation, with JSON body.

  {
    "operation":"nameOfOperation",
    "someParameter":"someValue"
  }

To Get Started

1. Install Node.js, ImageMagick for your system and make sure npm and magick are available as commands from CLI.
2. git clone this project, or extract from zip, to somewhere nice
3. npm update there for the dependencies
4. Make sure ArangoDB is listening on localhost:8529, then run db_restore.command from Finder (OS X: may need chmod +x first) or sh db_restore.command (UNIX) to load the database from JSON files
5. run run_as_dev.bat or run_as_dev.command to start the server in a CLI environment
6. Press Enter in terminal window whenever to restart server. You may also visit server:port/reload to do the same

这样开始

1. 为你的操作系统安装Node.js 和 ImageMagick，并确保 npm 与 convert 命令在命令行中可用
2. 通过 git clone 或者zip解压将本项目弄到某处
3. 在该处 npm update 以获取依赖项
4. 确保 ArangoDB 在 localhost:8529 监听, 然后从Finder运行 db_restore.command (OS X: 可能需要先 chmod +x) 或者 sh db_restore.command (UNIX) 以将JSON文件载入数据库
5. 运行 run_as_dev.bat or run_as_dev.command 以从命令行启动服务器
6. 在命令行窗口中随时按下 Enter 就可以重启服务器。 你也可以访问 server:port/reload 实现同样效果

Deployment

0. Do all above and make sure things does work
1. Install the forever package: npm install forever -g
2. Bash: sh run_as_production.sh Windows CMD: run_as_production.sh(or doubleclick)
3. Report bugs when necessary.

For your convenience

• scripts directory contains various scripts to accelerate deployment
• by default listens on localhost:1086
• server_settings.js includes several globally used server parameters and static serving routes and URL rewrites
• GET server:port/html/jade/somename will respond with rendered /nkc_modules/jade/somename.jade
• Every unrouted path will end up returning 404.jade
• query_functions.js is the database wrapper
• api_functions.js contains all the API functions. They are called before serving API/HTML requests
• im_functions.js contains wrapper for ImageMagick binaries.