Skip to content

FreesoSaiFared/wikitimeline-edits

 
 

Repository files navigation

🌟 WikiTimeline

Transform Wikipedia articles into beautiful, interactive timelines powered by AI

Live DemoFeaturesInstallationUsage

✨ Features

  • 🔄 Instant Conversion: Transform any Wikipedia article into a timeline in seconds
  • 🤖 AI-Powered: Utilizes Google Gemini to extract and organize chronological events
  • 📱 Responsive Design: Beautiful interface that works on all devices
  • 🌓 Dark Mode: Seamless experience in both light and dark themes
  • 🔄 Multi-Timeline: Compare multiple timelines side by side
  • 🎯 Interactive: Zoom, scroll, and explore events interactively

🚀 Installation

  1. Clone the repository:
git clone https://github.com/wenzhenl/wikitimeline.git
cd wikitimeline
  1. Install dependencies:
npm install
  1. Set up environment variables:
cp .env.example .env.development.local
  1. Configure your environment variables:

    • Get a Gemini API key from Google AI Studio
    • Set up Vercel KV storage:
      1. Install Vercel CLI: npm i -g vercel
      2. Link your project: vercel link
      3. Create a KV storage in Vercel Dashboard
      4. Connect KV to your project
      5. Pull environment variables: vercel env pull .env.development.local
  2. Run the development server:

npm run dev

🌐 Deployment

  1. Deploy to Vercel:
vercel deploy
  1. Configure production environment variables in Vercel Dashboard:
    • Add all variables from .env.example
    • Connect Vercel KV storage

💡 Usage

  1. Visit the homepage
  2. Search for any Wikipedia topic
  3. Select from the autocomplete suggestions
  4. Click "Generate Timeline" to view your interactive timeline
  5. For multiple timelines, keep adding topics before generating

🎯 Example Timelines

🛠️ Tech Stack

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.


About

WikiTimeline-Edits: Show how articles developed through time

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.2%
  • JavaScript 4.6%
  • CSS 0.2%