The News Threads Client is a web application for exploring and tracing news provenance across time over a collection of documents.
Перейти к файлу
Derek Worthen 6d66eab78b
Create ci.yml
2020-09-09 10:23:40 -07:00
.github/workflows Create ci.yml 2020-09-09 10:23:40 -07:00
.vscode Initial code commit 2020-09-09 09:39:40 -07:00
config Initial code commit 2020-09-09 09:39:40 -07:00
packages Initial code commit 2020-09-09 09:39:40 -07:00
.docsignore Initial code commit 2020-09-09 09:39:40 -07:00
.docsrc Initial code commit 2020-09-09 09:39:40 -07:00
.eslintignore Initial code commit 2020-09-09 09:39:40 -07:00
.eslintrc.js Initial code commit 2020-09-09 09:39:40 -07:00
.gitignore Initial code commit 2020-09-09 09:39:40 -07:00
.huskyrc Initial code commit 2020-09-09 09:39:40 -07:00
.npmrc Initial code commit 2020-09-09 09:39:40 -07:00
.prettierignore Initial code commit 2020-09-09 09:39:40 -07:00
.prettierrc Initial code commit 2020-09-09 09:39:40 -07:00
.spelling Initial code commit 2020-09-09 09:39:40 -07:00
CODE_OF_CONDUCT.md Initial CODE_OF_CONDUCT.md commit 2020-08-10 23:05:52 -07:00
LICENSE Initial LICENSE commit 2020-08-10 23:05:52 -07:00
README.md Initial code commit 2020-09-09 09:39:40 -07:00
SECURITY.md Initial code commit 2020-09-09 09:39:40 -07:00
package.json Initial code commit 2020-09-09 09:39:40 -07:00
pnpm-lock.yaml Initial code commit 2020-09-09 09:39:40 -07:00
pnpm-workspace.yaml Initial code commit 2020-09-09 09:39:40 -07:00
tsconfig.json Initial code commit 2020-09-09 09:39:40 -07:00

README.md

Introduction

News Threads Client is a web application for exploring and tracing news provenance across time over a collection of documents. This project can ingest and analyze data produced by the News-Threads data pipeline.

News Provenance research

Getting Started

Prerequisites

Data Ingestion

The scripts package provides commands for ingesting data produced by News-Threads. See packages/scripts for more information and instructions.

Configuration

By default, the Azure Function API will run on port 7071 and connect to a local MongoDB instance, mongodb://localhost:27017/. Default configuration settings can be changed by updating packages/<package>/config/default.json. Alternatively, default configuration settings can be overwritten by adding local-<NODE_ENV>.json configuration files to the corresponding config directory.

Startup

> pnpm install # --ignore-engines (if azure gives you grief about node version)
> pnpm start

The webapp will be available at http://localhost:8080

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.