07f6a1a058 | ||
---|---|---|
.github/workflows | ||
.vscode | ||
config | ||
packages | ||
.docsignore | ||
.docsrc | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
.huskyrc | ||
.npmrc | ||
.prettierignore | ||
.prettierrc | ||
.spelling | ||
CODE_OF_CONDUCT.md | ||
LICENSE | ||
README.md | ||
SECURITY.md | ||
package.json | ||
pnpm-lock.yaml | ||
pnpm-workspace.yaml | ||
tsconfig.json |
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.
Getting Started
Prerequisites
- Node (check
package.json::engines
for version details) - Pnpm (check
package.json::engines
for version details) - MongoDB
- Azure CLI
- Azure Functions Core
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.