Skip to content

Kantai Collection game information sharing server using restful API running on node.js

License

Notifications You must be signed in to change notification settings

boholder/KanColleRest

Repository files navigation

KanColleREST

A restful api server mainly using node.js with express framework and using nedb databse, to provide game information about a webpage game named "Kan Tai Collection".

Game's official site:www.dmm.com/netgame/social/-/gadgets/=/app_id=854854/

For more information, check Wiki.

API

All APIs only accept GET requests now.

Ship

  • v1/ship/info

    • Ships information
  • v1/ship/cg

    • Ships CG (regular CG/ seasonal limited CG/ other images about ships)

Setting up the server

Attention here. Cloning this project will cost 2.3G (all from submodules) traffic, small bandwidth or billing traffic server should be reconsidered whether to clone this project or directly download it via a resuming download link. (Apologize again for the size.)

  1. Run install script uploaded on github (or review it before):
source <(curl -s https://raw.githubusercontent.com/boholder/KanColleRest/master/install-kcrest.sh) 

(https://raw.githubusercontent.com returns 443? Go to that file on github and manually copy it down and run.)

  1. Set NODE_ENV environment variable to production
Windows:
set NODE_ENV=production
Linux:
export NODE_ENV=production
  1. Start the server.
npm start

You may be interested in starting server as background service, check this discuss on stackoverflow for a proper solution. I have tried to imitate project fhs-install-v2ray to run the server via Linux systemd, and wrote the logic inside install script, but I have trouble writing scripts due to leak of bash knowledge.

Related (bing used by this project as resources) projects and websites

Acknowledgement

  • @Diablohu - Who provides an excellent database & image resource and shows me how to use them.
  • @Bluefissure - Whose project FFXIVBOT inspired me.
  • @Mian - Who provides screenshots of Moegirl Wiki KanColle Column, so I can provide an image format ship information response for convenient.
  • @Wei - My friend who noticed me that I can't just leave a mess on Github then pretend it doesn't exist, that goes against professionalism.

About

Kantai Collection game information sharing server using restful API running on node.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages