The TV Kitchen is a playground that turns TV into data (transcripts, facial recognition, etc.) so that newsrooms can help their staff and readers better understand what is happening across various local and cable TV news outlets.

If you are interested in running the TV Kitchen as a developer please review our install instructions.

If you are interested in running the TV Kitchen as a user please visit our website.

1. If you are not already running your own instance of Kafka, start Kafka:

yarn kafka:start

2. Start the kitchen itself

yarn start

To understand the overall architecture of the project, please review our architecture documentation.

The root structure is as follows:

- docs     // Project documentation
- services // Convenience containers for various external services (e.g. Kafka)
- src      // The primary code location itself
| - components // Architectural components
| - constants  // Constants used throughout the project
| - lib        // Supporting code (e.g. utilities, DB singletons, etc)
| - scripts    // Supporting scripts
| - tests      // System-wide / integration tests

TV Kitchen is an open source project, and we welcome contributions of any kind.

Thank you for considering, and before diving in please follow these steps:

• Step 1: read our code of conduct.
• Step 2: review our contribution guide.
• Step 3: make sure your contribution is related to an issue.
• Step 4: review these testing best practices.