Sign up
wikimedia
/
analytics-wikistats2
Public
Mirror from https://gerrit.wikimedia.org/g/analytics/wikistats2
51 stars
34 forks
master
Go to file
translatewiki
3 days ago
README.md
Wikistats 2.0
Wikistats is the public statistics website of the Wikimedia Foundation (WMF). Its main purpose is to add context and motivate our editor community by providing a set of metrics through which users can see the impact of their contributions in the projects they are a part of.
In Wikistats 2.0 we are not only updating the website interface but we are also providing new access to all our edit data in an analytics-friendly form. The transition of relying on static, precomputed datasets generated periodically into APIs querying our data lake improves drastically (and fundamentally changes) the way, time and resources it takes to calculate edit metrics both for the WMF and the community.
Local install for development
Cloning the project
The minimum requirements to install the Wikistats UI are Node.js 8+, npm 6+, and git. The project is hosted in a Phabricator repository
git clone https://gerrit.wikimedia.org/r/analytics/wikistats2 npm install
Third-party UI elements
Wikistats uses many components from the Fomantic UI library. This should build itself with gulp when it's first loaded. If there are any changes to semantic/src/site/globals/site.variables​, fomantic css will need to be rebuilt:
cd node_modules/fomantic-ui ./node_modules/gulp/bin/gulp.js build-css
Generating the bundle
Last, you need to generate the Javascript bundle that contains the Wikistats project, its dependencies and the stylesheets. Assuming you want a development environment, you should run:
npm run dev
This command will set up a watcher that will rebuild the bundle each time a project file changes. The production environment won't minify the bundle so that code is readable within the browser developer tools. This will generate the static site in ./dist-dev within your wikistats repository directory. In order to see the built site you need a simple http server such as python's SimpleHTTPServer
npm run server
The application should be now working in localhost:5000
Tests
Tests are located in the test directory. We use Jest as our test runner. Running the following:
npm test
Additionally, there are smoke tests to be performed with each significant change to the codebase, which are described in Analytics/Wikistats 2/Smoke testing.
Bug report and Feature request
Please fill this Phabricator template to report a bug or request a new feature.
Contributing and Deployment
Please read through our contributing guidelines. Included are directions for code reviews, and notes on deployment.
Built With
Community
Get updates on Wikistats 2.0 development and chat with the project maintainers and community members.
Chat with community members on IRC server, in the #wikimedia-analytics channel.
Copyright
All data, charts, and other content is available under the Creative Commons CC0 dedication.
Releases
7 tags
Contributors 16
+ 5 contributors
Languages
JavaScript54.0%
Vue44.5%
Other1.5%
© 2022 GitHub, Inc.
Terms
Privacy
Security
Status
Docs
Contact GitHub
Pricing
API
Training
Blog
About
Actions Automate any workflow Packages Host and manage packages Security Find and fix vulnerabilities Codespaces Instant dev environments Copilot Write better code with AI Code review Manage code changes Issues Plan and track work Discussions Collaborate outside of code All features Documentation GitHub Skills Blog Enterprise Teams Compare all CI/CD & Automation DevOps DevSecOps Customer Stories Resources GitHub Sponsors Fund open source developers The ReadME Project GitHub community articles Topics Trending Collections Pricing
CodeCodePull requestsPull requestsActionsActionsSecuritySecurityInsightsInsights Code Pull requests Actions Security Insights