Skip to content

Github mirror of "analytics/mediawiki-storage" - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing

License

Notifications You must be signed in to change notification settings

wikimedia/analytics-mediawiki-storage

Repository files navigation

mediawiki-storage

Get JSON content from MediaWiki using JSONP

Use

Install normally with npm.

npm install --save mediawiki-storage

Use to modify and develop

Get the source code from Wikimedia's Gerrit repository.

git clone https://gerrit.wikimedia.org/r/analytics/mediawiki-storage

We're using Bower for production dependencies, Karma as a test runner and Gulp as a build tool. Then, install the dependencies to be able to build and run mediawiki-storage and its tests.

cd mediawiki-storage
npm install

Now you can run Gulp tasks to lint, build and clean the project; Where command can be one of: lint, build or clean. If you omit command, Gulp defaults to executing build task.

npm run gulp <command>

You can also run the tests, and let Karma test runner watch all files and execute all tests on changes with:

npm run karma start

Or run both gulp build and karma start with:

npm test

API documentation

See the API documentation here.

Future plans

In the future, we'd like to add write capability to the library, so that we can also update the contents of MediaWiki JSON pages.

About

Github mirror of "analytics/mediawiki-storage" - our actual code is hosted with Gerrit (please see https://www.mediawiki.org/wiki/Developer_access for contributing

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published