A visual life journaling application that helps you reflect on your experiences through an interactive timeline interface. Unlike traditional diary apps, Timeline provides a dynamic visualization of your life events, making it easier to see patterns and connections across time.
Try Timeline
Try it out here: https://mxmws.github.io/timeline or follow the instructions below to run it locally.
Getting Started
Prerequisites
- Node.js (v16 or higher)
- npm (v7 or higher)
Installation
# Clone the repository git clone https://github.com/mxmws/timeline.git # Navigate to project directory cd timeline # Install dependencies npm install
Development
Start the development server:
The application will be available at http://localhost:5173
Tech Stack
- React - Frontend framework
- Vite - Build tool and development server
- Tailwind CSS - Utility-first CSS framework
- ESLint - Code linting and style enforcement
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
To-Do
- Write comprehensive unit tests
- Add mobile support
- Add functionality to change category color
- Add functionality to change category order
- Add functionality to change event category
- Add functionality to change event name
- Add functionality to change category name
License
This project is licensed under the MIT License - see the LICENSE file for details.