OneLine: an AI tool for generating timelines of hot events

General Introduction

OneLine is an open source hot event timeline generation tool hosted on GitHub and developed by user chengtx809. It quickly generates a timeline of events through user-entered keywords, displaying the event time, title, description and related people.AI analysis function provides an in-depth interpretation of the background, process and impact of the event. The project is built with Next.js and React, supports Docker deployment, and is suitable for users interested in news, history or hot events.

Function List

• Keyword Generation: Generate a timeline of related events based on keywords entered by the user.
• Event details: displays the time, title, description and people involved in the event.
• Time Filtering: Supports filtering events by time range, making it easy to focus on a specific period of time.
• AI Analytics: provides an in-depth analysis of the context, course and impact of an event.
• Source tagging: labeling the source of information about an event to ensure that the content is credible.
• Front-end configuration: support for users to set up AI API endpoints, models and keys.
• Password Protection: Optionally set an access password to prevent misuse of the API configuration.

Using Help

OneLine is a web-based tool with source code and deployment methods available through a GitHub repository. Below is a detailed usage and deployment guide to help users get started quickly.

Visit the Demo site

OneLine provides an online demo site for users to experience the features:

1. Open your browser and visit https://oneline.chengtx.me/The
2. Enter keywords (e.g., "outbreak" or "technological breakthrough") in the page input box.
3. Click the Generate button to view the generated timeline with the time, title and description of the event.
4. Use the time filter function to select a specific year or month to narrow down the events.
5. Click on the AI Analyze button to get an interpretation of the context, process, and impact of the event.
6. Check the source of the incident to confirm the credibility of the information.

Local Deployment OneLine

If you want to run OneLine locally or on a server, you can get the source code and deploy it via the GitHub repository. Here are the detailed steps:

1. Access to source code

1. interviews https://github.com/chengtx809/OneLineThe
2. Click on the green Code button, select Download ZIP Download the source code, or copy the repository address:

   git clone https://github.com/chengtx809/OneLine.git
   

3. Unzip the file or go to the cloned folder and prepare to configure the environment.

2. Configuration environment

OneLine requires external AI API (e.g. Google Gemini or OpenAI) support. Configuration is divided into front-end configuration and environment variable configuration.

Front-end configuration:

1. After launching OneLine, open the webpage and click the "API Settings" button on the top right corner.
2. Enter the following information:
   • API endpointsAs https://api.example.com/v1/chat/completionsThe
   • Model nameAs gemini-2.0-pro-exp-searchThe
   • API key: Get it from your API provider.
3. If an access password is set, enter the correct password to modify the configuration.
4. Save the settings and test the functionality.

Environment variable configuration (recommended for deployment):

1. In the project root directory, find the .env.example file, copy it and rename it .env.localThe
2. compiler .env.local, fill in the following:

   NEXT_PUBLIC_API_ENDPOINT=https://api.example.com/v1/chat/completions
   NEXT_PUBLIC_API_MODEL=gemini-2.0-pro-exp-search
   NEXT_PUBLIC_API_KEY=your_api_key_here
   NEXT_PUBLIC_ALLOW_USER_CONFIG=true
   NEXT_PUBLIC_ACCESS_PASSWORD=your_access_password_here
   

3. Configuration Notes:
   • NEXT_PUBLIC_API_ENDPOINT: The address of the AI API.
   • NEXT_PUBLIC_API_MODEL: Name of the AI model used.
   • NEXT_PUBLIC_API_KEY: Your API key.
   • NEXT_PUBLIC_ALLOW_USER_CONFIG: set to false Configuration changes can be disabled on the front end.
   • NEXT_PUBLIC_ACCESS_PASSWORD: Optional password to protect API settings.
4. Save files to ensure that sensitive information is not disclosed.

3. Deployment with Docker

OneLine supports Docker deployment, thanks to contributor justincnn for the image. Procedure:

1. Ensure that Docker is installed (refer to https://docs.docker.com/get-docker/).
2. Run the following command to pull the image:

   docker pull justincnn/oneline
   

3. Run the container, mapping the port (default 3000):

   docker run -p 3000:3000 justincnn/oneline
   

4. Open your browser and visit http://localhost:3000If you are a member of the OneLine team, go to the OneLine page.
5. If a persistent configuration is required, set the .env.local file is mounted to the container:

   docker run -p 3000:3000 -v /path/to/.env.local:/app/.env.local justincnn/oneline
   

4. Manual deployment (non-Docker)

1. Make sure Node.js is installed (v16 or above recommended).
2. Go to the project directory and install the dependencies:

   npm install
   

3. Start the development server:

   npm run dev
   

4. interviews http://localhost:3000The API can be configured and used.

Using the main functions

Here's how to operate OneLine's core functions:

Generate Timeline

1. Enter a keyword such as "artificial intelligence development" on the home page.
2. Click on the "Generate" button, wait a few seconds and the timeline will be displayed.
3. The timeline is sorted chronologically and shows the event title, date, description and people involved.
4. Hover over the event to see the details.

Time Screening

1. Find the filter bar at the top of the timeline and select the year (e.g. 2020-2025) or month.
2. Click the "Apply" button and the timeline is updated with the events in the filtered range.
3. If you need to reset, click "Clear Filter".

AI Analytics

1. Select an event in the timeline and click on the "AI Analyze" button.
2. The system calls the configured AI APIs to generate context, process, and impact analysis of the event.
3. The results of the analysis are displayed below the event and contain textual descriptions that may address causes, effects, and trends.

Inspection of sources

1. There is a source marker next to each event, click on it to see the original link or source.
2. If the source is not credible, submit an Issue on GitHub to suggest improvements.

Participation in community contributions

OneLine is an open source project and user contributions are welcome:

1. To access the GitHub repository, click Issues View issues or submit a new one.
2. Fork the repository, change the code, and submit a Pull Request, for example, to optimize the timeline UI or add support for a new language.
3. Run tests before committing:

   npm run test
   

4. Describe the changes in the Pull Request and wait for review.

Frequently Asked Questions

• API Configuration Failure: Verify that the API endpoint, model, and key are correct, or check the network connection.
• Timeline not displayed: Ensure that keywords are specific (e.g., "2023 science and technology event") and avoid being overly broad.
• Docker startup errors: Check if Docker is running and if the port is occupied.
• AI analyzes content inaccurately: Replace the AI model with a more powerful one, or feed back issues at GitHub.

With these steps, users can easily deploy and use OneLine to quickly generate hot event timelines and get AI analytics.

application scenario

1. Press Release Collation
   Journalists use OneLine to enter keywords and generate a timeline of events, quickly organizing the news and assisting in story writing.
2. historical research
   Students or researchers enter historical events and get timelines and AI analysis to understand the context and impact of the event.
3. Hot Tracking
   The public inputs current hot topics, views the development of events, filters key time points, and grasps the latest developments.
4. teaching and learning
   Teachers use OneLine to generate a timeline of events to use as classroom material to help students understand complex events.

QA

1. What AI APIs does OneLine support?
   Support for Google Gemini, OpenAI, etc., depending on user-configured endpoints and models.
2. Programming experience required?
   No, using the Demo site requires only keyword entry; deployment requires basic command-line knowledge.
3. Where does the timeline data come from?
   Data is generated by AI from publicly available information based on keywords, with the source labeled next to the event.
4. Can it be used offline?
   Networking is required to invoke AI APIs, some functions can be offline after local deployment, but AI analysis relies on the network.
5. How do I secure my API keys?
   Use environment variable configuration to avoid exposing keys on the front-end and set access passwords for added protection.