Skip to content
ka2 edited this page Jun 27, 2024 · 2 revisions

Welcome to the Sunorhc.Timeline wiki!

Overview

Sunorhc.Timeline is an open source project that aims to provide a customizable horizontal timeline component for web pages, designed to empower front-end developers with the ability to manage categorized, chronological events in an intuitive interface.

Features

  • Setting up a timeline is quick and easy.
  • High degree of customization freedom: Brief description.
  • High performance with asynchronous event loading and event caching.
  • Intuitive and interactive operation via drag and click.
  • Supports operation on touch devices.
  • Type-safe robustness and extensibility with TypeScript.

Getting Started

To get started with Sunorhc.Timeline, follow these steps:

  1. Clone the repository:
    git clone https://github.com/ka215/sunorhc.timeline.git
  2. Install dependencies:
    cd sunorhc.timeline
    pnpm i
  3. Build the application:
    pnpm build

Note: The above example uses pnpm as the package manager, but you can also use npm, yarn, etc.

Documentation

For detailed documentation, please refer to the following pages:

Contributing

We welcome contributions!
Please read our contributing guidelines to get started.

License

This project is licensed under the MIT License.

Clone this wiki locally