DailyHotApi

The project supports one-click deployment on several cloud platforms. For most of these, you should first fork the repository to your own account to enable the deployment process.

• Vercel: Use the Vercel deployment button or visit the dedicated Vercel repository.
• Railway: Fork the repository and use the Railway one-click deploy feature.
• Zeabur: Fork the repository and use the Zeabur one-click deploy feature.

You can use PM2 for process management. Ensure PM2 is installed globally before running the deployment script.

npm i pm2 -g
sh ./deploy.sh

You can integrate dailyhot-api directly into your Node.js project by installing the package and calling serveHotApi.

Note: Using this method may prevent access to certain interfaces that require a Puppeteer environment.

pnpm add dailyhot-api

import serveHotApi from "dailyhot-api";

/**
 * Start the server
 * @param {Number} [port] - Port number
 * @returns {Promise<void>}
 */
serveHotApi(3000);

To deploy manually on your own machine or server, follow these steps:

1. Clone the repository and enter the directory.
2. Install dependencies using npm install.
3. Copy /.env.example to /.env and configure your settings.
4. Run in development mode with npm run dev or build and start with npm run build && npm run start.

You can deploy the DailyhotApi service using Docker Compose. By default, the service maps port 6688 on the host to port 6688 in the container and persists logs to a local ./logs directory. The service is configured to run as user 114514 and will automatically restart if it fails.

version: "3.8"

services:
  DailyhotApi:
    build:
      context: .
      target: runner
    ports:
      - "6688:6688"
    volumes:
      - "./logs:/app/logs"
    environment:
      - PORT=6688
    user: "114514"
    restart: always

The project uses a PM2 ecosystem configuration file to manage the application process. You can customize the application name, port, and environment variables by modifying ecosystem.config.cjs before deploying with PM2.

module.exports = {
  apps: [{
    name: 'daily-news',
    script: 'npm',
    args: 'start',
    instances: 1,
    autorestart: true,
    watch: false,
    max_memory_restart: '1G',
    env: {
      NODE_ENV: 'development',
      PORT: 6688
    }
  }]
}

When deploying via Docker or Docker Compose, you can control the application's listening port using the PORT environment variable.

environment:
  - PORT=6688

The dailyhot-api project is configured using environment variables. You can set these in a .env file or directly in your deployment environment. The application uses dotenv to load these values.

Below is the complete list of available configuration keys, their default values, and their types:

To avoid frequent requests to official data sources, the project implements a default cache of 60 minutes. If you need to change this behavior, you must modify the configuration in your .env file.

Warning: Some interfaces use web scrapers. Ensure your usage complies with the rules of the target websites.