Newsnow

You can deploy Newsnow using Docker Compose. Ensure the docker-compose.yaml file is in the project root directory, then run:

docker compose up

You can also configure environment variables directly within the docker-compose.yaml file.

NewsNow supports database connectors via db0.unjs.io. Cloudflare D1 is the recommended database.

1. Create a D1 database in your Cloudflare Worker dashboard.
2. Configure database_id and database_name in your wrangler.toml file.
3. If wrangler.toml does not exist, rename example.wrangler.toml and update the settings.
4. Changes will be applied upon your next deployment.

To develop locally, you need Node.js >= 20. Follow these steps to set up your environment:

1. Enable corepack: corepack enable
2. Install dependencies: pnpm i
3. Start development server: pnpm dev

If you wish to add new data sources, explore the shared/sources and server/sources directories.

To enable GitHub login and data synchronization, you must create a GitHub App and configure the callback URL.

1. Create a new GitHub App at GitHub Settings.
2. No special permissions are required.
3. Set the Callback URL to: https://your-domain.com/api/oauth/github (replace your-domain.com with your actual deployed domain).
4. Save the generated Client ID and Client Secret for use in your environment variables.

To deploy a version of Newsnow without login and caching functionality, you can use Cloudflare Pages or Vercel.

For Cloudflare Pages specifically, use the following build settings:

• Build command: pnpm run build
• Output directory: dist/output/public

To enable GitHub login and data synchronization, you must create a GitHub App:

1. Create a new GitHub App at GitHub Settings.
2. No special permissions are required.
3. Set the Callback URL to: https://your-domain.com/api/oauth/github (replace your-domain.com with your actual deployment domain).
4. Obtain your Client ID and Client Secret from the GitHub App settings.

To deploy Newsnow to Cloudflare Pages, fork the repository and import it into your Cloudflare dashboard. Ensure you use the following build settings:

• Build command: pnpm run build
• Output directory: dist/output/public

To extend the news coverage, you can add new data sources by modifying the files in the following directories:

• shared/sources
• server/sources

The project uses a clean architecture with full type definitions to support new sources.

Ensure you have Node.js >= 20 installed. Follow these steps to start the development server:

1. Enable corepack: corepack enable
2. Install dependencies: pnpm i
3. Start development mode: pnpm dev

Newsnow supports Cloudflare D1 for database storage.

1. Create a D1 database in your Cloudflare Worker dashboard.
2. Configure your wrangler.toml file with the database_id and database_name.
3. If you do not have a wrangler.toml, rename the provided example.wrangler.toml and update the configuration.
4. Redeploy your project to apply the changes.

Local development requires Node.js version 20 or higher. Use corepack and pnpm to set up the environment:

1. Enable corepack.
2. Install dependencies.
3. Run the development server.

corepack enable
pnpm i
pnpm dev

Newsnow requires several environment variables for authentication, database initialization, and caching. For local development, rename example.env.server to .env.server and populate the following keys:

# Github Client ID
G_CLIENT_ID=
# Github Client Secret
G_CLIENT_SECRET=
# JWT Secret, usually the same as Client Secret
JWT_SECRET=
# Initialize database, must be set to true on first run, can be turned off afterward
INIT_TABLE=true
# Whether to enable cache
ENABLE_CACHE=true