Socket
Socket
Sign inDemoInstall

miniwiki

Package Overview
Dependencies
116
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    miniwiki

mini-Wikipedia API


Version published
Weekly downloads
1
Maintainers
1
Created
Weekly downloads
 

Readme

Source

miniwiki v0.1.0

Mini-Wikipedia API and Website

Features

  • Written in CoffeeScript for Node.js
  • Clusters enable utilization of all cores
  • Promises avoid blocking while recursively calculating fibonacci(34)
  • Cassandra used as persistent storage via DataStax driver
  • HTML Page caching using Jade templates
  • Docker containerizes apps for portability

Roadmap

  • Will implement Closure Compiler to compile CoffeeScript into minified JavaScript for efficiency and speed
  • Will implement Nginx for load balancing between servers and clusters
  • Will implement apicache for caching API responses
  • Will implement Kafka to handle caching when updating articles
  • Will implement Unit and Benchmark Testing via Mocha and StrongLoop

Prerequisites

  • Docker
  • npm

Installation

Use npm to install miniwiki:

npm install miniwiki

Running

Run from miniwiki directory:

docker build .

Usage

miniwiki is made up of 2 apps: api and web. Each has its own endpoints:

Retrieving Latest_plane_crash article from Web:

curl http://127.0.0.1:8000/wiki/Latest_plane_crash

Updating Latest_plane_crash article from API:

curl --request PATCH http://127.0.0.1:3000/v1/articles/Latest_plane_crash?summary=Latest+plane+crashes

FAQs

Last updated on 06 May 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc