Setting up dev environment

Set up local development environment

• Download Node.js and npm at https://nodejs.org/en/download/. You need at least Node version 7.6 because Wikidocumentaries uses Async, which in only supported since that version (https://www.infoq.com/news/2017/02/node-76-async-await).
• Clone the repositories from GitHub to your local hard drive
  • https://github.com/Wikidocumentaries/wikidocumentaries-ui
  • https://github.com/Wikidocumentaries/wikidocumentaries-api

Build setup: wikidocumentaries-ui

See https://github.com/Wikidocumentaries/wikidocumentaries-ui

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# serve with hot reload at localhost:8080
# and use a local wikidocumentaries-api instead of the production one
API_URL=http://localhost:3000/ npm run dev

# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

# run unit tests
npm run unit

# run all tests
npm test

• Set environment variables. There are three environment variables to define. You can ask for them in the developer Slack or mail susanna.anas@gmail.com. In a Mac (bash) you can define them like this:

export WIKIDOCUMENTARIES_API_USER_AGENT=<email address>
export FLICKR_KEY=<flickr key>
export BING_MAPS_KEY=<Bing maps key>
export MAPBOX_ACCESS_TOKEN=<Mapbox access token>
export TROVE_API_KEY=<Trove API key>
export EUROPEANA_API_KEY=<Europeana API key>
export SMITHSONIAN_API_KEY=<Smithsonian API key>

Wikimedia and project accounts

1. Get a Wikimedia account (the same account for all Wikipedias, Wikimedia Commons, Wikidata etc.) e.g. https://www.wikidata.org/wiki/Special:UserLogin
2. Get the Wikimedia developer account > Registration instructions under "VPS and General Users". The same key and password let you access The Wikimedia Cloud Services at https://wikitech.wikimedia.org and the git repositories located at https://gerrit.wikimedia.org/. You are also creating a separate Shell account. Read also:
   • https://wikitech.wikimedia.org/wiki/Main_Page
   • https://wikitech.wikimedia.org/wiki/Help:Access
3. Create an account in Wikimedia Phabricator
4. Ask to join the codebase in GitHub
5. Ask for an account to edit this wiki

Communication channels for developers

• Wikidocumentaries Github repository
• Wikidocumentaries Phabricator project
• Wikidocumentaries Slack channel Developers in channel #technology.

Navigation

About	Technology	Design	Content modules	Tool pages	Projects
Status Wikidocumentaries blog Wikidocumentaries demo Phabricator project Facebook group GitHub repository Translation in TranslateWiki Wikidocumentaries Slack	Setting up dev environment Resources Translations Languages Using Wikibase Federation with Wikidata APIs Linking Media metadata Properties to content User registration Licensing	Page types Landing page Search page Topic page User page Organisation page Project page Tool page Tasks Components Main toolbar and footer Search Faceting Topic page header Content module Dropdown Modal Icons	Active modules Article Family tree Gallery Historical map Images Image viewer Infobox Map Module ideas Audio/Video Bibliography Correspondence Discussion Graph Name Newspaper articles Testimonials Timeline Visualizations Wikidocumentary 3D	Visual editor Query tool QuickStatements Open Refine Creating topics Uploading images Geolocating tool Metadata editor Rectifying maps Transcription Annotation tool	Central Park Archives Convent Quarter Wikisource