README.md 1004 Bytes
Newer Older
KevinPayravi's avatar
KevinPayravi committed
1
2
# View it

KevinPayravi's avatar
KevinPayravi committed
3
View it! is a tool that shows Wikipedia readers and editors relevant Wikimedia Commons media depicting—or otherwise related to—the article they are reading. View our [documentation on Meta wiki](https://meta.wikimedia.org/wiki/View_it!_Tool) for more information.
KevinPayravi's avatar
KevinPayravi committed
4

KevinPayravi's avatar
KevinPayravi committed
5
The tool is in active develop. Frequent changes should be expected through at least the end of 2022.
KevinPayravi's avatar
KevinPayravi committed
6

KevinPayravi's avatar
KevinPayravi committed
7
This repository is for the code behind https://view-it.toolforge.org/. A [user script](https://meta.wikimedia.org/wiki/User:SuperHamster/view-it.js) is also available to add a portlet link to View it! when viewing articles across Wikimedia wikis.
KevinPayravi's avatar
KevinPayravi committed
8

KevinPayravi's avatar
KevinPayravi committed
9
10
## Installation
This is an Express JavaScript project.
KevinPayravi's avatar
KevinPayravi committed
11

KevinPayravi's avatar
KevinPayravi committed
12
To run locally:
KevinPayravi's avatar
KevinPayravi committed
13
```
KevinPayravi's avatar
KevinPayravi committed
14
15
16
export PORT=3000
npm install
node server.js
KevinPayravi's avatar
KevinPayravi committed
17
18
19
```

## Support
KevinPayravi's avatar
KevinPayravi committed
20
Questions, comments, and suggestions can be placed on our projects [Meta talk page](https://meta.wikimedia.org/wiki/Talk:View_it!_Tool).
KevinPayravi's avatar
KevinPayravi committed
21

KevinPayravi's avatar
KevinPayravi committed
22
Issues and tasks are tracked on [Phabricator](https://phabricator.wikimedia.org/project/view/6085/).