Skip to content

mingqian/timeline

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Timeline Application

A vertical chronological timeline application inspired by Windows 10's Timeline, built with TimelineJS and Vite.

Features

  • 📅 Vertical timeline layout
  • 📝 JSON-based data configuration
  • 🎨 Windows 10 Timeline-inspired design
  • ⚡ Fast development with Vite
  • 🔄 Live reload during development

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn

Installation

  1. Install dependencies:
npm install

Development

Start the development server:

npm run dev

The application will open automatically at http://localhost:3000

Build

Create a production build:

npm run build

Preview the production build:

npm run preview

Configuration

Timeline Data

Edit src/timeline-data.json to customize your timeline events. The JSON structure follows TimelineJS format:

{
  "title": {
    "text": {
      "headline": "Your Timeline Title",
      "text": "Description"
    }
  },
  "events": [
    {
      "start_date": {
        "year": "2024",
        "month": "1",
        "day": "1"
      },
      "text": {
        "headline": "Event Title",
        "text": "Event description"
      }
    }
  ]
}

Project Structure

timeline/
├── src/
│   ├── main.js              # Application entry point
│   ├── style.css            # Custom styles
│   └── timeline-data.json   # Timeline events data
├── index.html               # Main HTML file
├── vite.config.js           # Vite configuration
├── package.json             # Project dependencies
└── README.md                # This file

Technologies

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published