This is a web app project built to allow people to fight vandalism on Wikipedia collaboratively. See [[m:WikiProject_WikiLoop]] for more introduction. The documentation in this repository focuses on development of the software itself.
We welcome contributions! See our contribution policy. Please check out our stack diagram to get familiar with the technologies we depend on.
Prerequisite: git, nodejs, npm
git clone git@github.com:google/wikiloop-doublecheck.git
cd wikiloop-doublecheck
npm install
** If you don't intent to config environment variables you can skip this part, and skip to next section **
To configure more variables, you should create a dev.env
file containing environment variables needed by this project used by dotenv
. A template has been provided in the template.env
. Once set, you should do cp template.env dev.env
to create such file in the exact name, and then do
export DOTENV_PATH="dev.env"
Prerequisite: NuxtJS with VueJS and ExpressJS.
To run a local dev instance, which gives you hot reload and a dev tool (Vue DevTool) friendly instance:
npm run dev
To build and run a local instance with like a prod:
npm run build
npm start
npm test
Prerequisite: CircleCI
We run our continuous integration with CircleCI. To run continuous integration locally:
circleci local execute build
Thanks goes to these wonderful people (emoji key):
Add contributor through the following command
npx all-contributors add $NEW_CONTRIBUTOR translation
We greatly appreciate the following volunteers for helping us translate / proofread our (machine translated) texts.
- ZH: @tzuhsiao
- UK: @MT-Wizard, @adehtiarov
- IT: @alex-martelli
- ES: @apatronl, @fmobus
- PT: @fmobus, @he7d3r, Ted Hardie,
- JA: @luisfors-g, @renamoo
- RU: Andrei Goriachev
This project follows the all-contributors specification. Contributions of any kind welcome!