WikiLoop Battlefield: Fight vandalism on Wikipedia together

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.

Website Status

Quick Start

We welcome contributions! See our contribution policy. Please check out our stack diagram to get familiar with the technologies we depend on.

Deploy a Dev Instance on Heroku

Install

Prerequisite: git, nodejs, npm

git clone git@github.com:google/wikiloop-battlefield.git
cd wikiloop-battlefield
npm install

Setup

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"

Run

Prerequisite: NuxtJS with VueJS and ExpressJS.

To run a local dev instance, which gives you hot reload and a devtool (Vue DevTool) friendly instance:

npm run dev

To build and run a local instance with like a prod:

npm run build
npm start

Test

Prerequisite: Docker, Jest

npm test

Continuous Integration

Prerequisite: CircleCI

We run our continuous integration with CircleCI. To run continuous integration locally:

circleci local execute build

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Add contributor through the following command

npx all-contributors add $NEW_CONTRIBUTOR translation

_xinbenlv 📖 💻 🌍 🐛 🖋 🤔 📆 ✅	_{Ashwin Ramaswami} 🚇 💻	_{Hamdanil Rasyid} 🌍 💻 🐛	_{Ali GOREN} 🌍 🐛 💻	_Elan 🐛	_{ExtremoBlando} 🐛	_ChaoyueFred 📹
_{Denny Vrandečić} 🐛	_{Wisnu Adi Nurcahyo} 🐛	_curimit 🐛	_{Andrew G. West} 💬 🔧	_{Martins Brunenieks} 🌍	_{Florian Körner} 💻	_{dz_s} 💻
_{Bhavya Karia} 🌍