Skip to content

Latest commit

Β 

History

89 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Tick-Tock Logo

πŸ• Tick-Tock - Intelligent Time Logging

Tick-Tock is a modern time logging application that transforms the way developers track their work. Instead of complex time tracking interfaces, simply write natural language messages and let our intelligent system create structured time logs automatically.

Built with modern React 19 and TypeScript, powered by TanStack ecosystem for optimal performance and developer experience.

πŸš€ Key Innovation: Write time logs like journal entries, automatically sync with Jira, and manage everything through an intuitive calendar dashboard.

Version React TypeScript TanStack Query License

✨ Features

πŸ€– Natural Language Processing

Transform simple messages like "Worked on XYZ-1111 for 3 hours implementing authentication, had 1 hour meeting with team about XYZ-2222 planning" into structured time entries automatically.

πŸ“Š Visual Calendar Dashboard

  • Smart Status Indicators: Orange (needs logging), Blue (draft entries), Green (completed)
  • Quick Navigation: Click any day to view or edit time logs
  • Monthly Overview: Clear visualization of your logging progress

πŸš€ Draft-First Workflow

  • Review Before Commit: All logs start as drafts for your review
  • Intelligent Refinement: Request changes in natural language
  • One-Click Sync: Ship approved logs directly to Jira

πŸ”— Seamless Jira Integration

  • Direct API Integration: Real-time synchronization with Jira time tracking
  • Task Validation: Automatic verification of Jira task IDs
  • Error Handling: Robust retry logic and user feedback

🎨 Modern User Experience

  • React 19 Features: Actions, useActionState, and concurrent rendering
  • Responsive Design: Perfect on desktop, tablet, and mobile
  • Dark Mode Support: Automatic theme switching
  • Accessibility First: WCAG 2.1 AA compliant

πŸš€ Quick Start

Get Tick-Tock running locally in minutes:

Prerequisites

  • Node.js 20+ (required for optimal performance)
  • npm or yarn
  • Jira instance with API access (for production use)

Installation

  1. Clone the repository:
git clone https://github.com/IgorWnek/tick-tock-frontend.git
cd tick-tock-frontend
  1. Install dependencies:
npm install
  1. Set up environment variables:
cp .env.dist .env.local
  1. Start the development server:
npm start
  1. Open your browser and navigate to http://localhost:3000

πŸŽ‰ You're ready to start logging time! The app runs with MSW (Mock Service Worker) by default, so you can test all features without a backend.

Production Setup

For production deployment, configure these environment variables in .env.local:

  • VITE_API_BASE_URL - Your backend API endpoint
  • VITE_JIRA_BASE_URL - Your Jira instance URL
  • VITE_SENTRY_DSN - Error monitoring (optional)

πŸ“œ Available Scripts

npm run [command]

Development

  • start - Launch development server with hot reloading on http://localhost:3000
  • typecheck - Run TypeScript type checking without emitting files
  • test - Run unit tests with Vitest
  • coverage - Generate test coverage report

Building & Deployment

  • build - Create optimized production build (includes TypeScript check)
  • build:ci - Production build optimized for CI/CD pipelines
  • build:analyze - Build with bundle analysis visualization
  • preview - Preview production build locally

Code Quality

  • lint - Validate code with ESLint and Stylelint
  • lint:fix - Auto-fix linting issues where possible

Testing & E2E

  • e2e - Run end-to-end tests (default browser)
  • e2e:firefox - Run E2E tests in Firefox
  • e2e:chrome - Run E2E tests in Chrome
  • e2e:safari - Run E2E tests in Safari
  • e2e:debug - Run E2E tests in debug mode

Development Tools

  • plop - Interactive code generation CLI
  • translations - Fetch latest translations using Babelsheet

πŸ—οΈ Technology Stack

Tick-Tock is built with modern, battle-tested technologies:

Core Framework

  • React 19 - Latest React with Actions, useActionState, and concurrent features
  • TypeScript 5.9 - Full type safety and modern JavaScript features
  • Vite 5 - Lightning-fast build tool and development server

Routing & State Management

UI & Styling

  • TailwindCSS 4 - Utility-first CSS framework with modern features
  • Shadcn/UI - Beautiful, accessible components built on Radix UI
  • Lucide React - Modern icon library with 1000+ icons

Development & Testing

  • Vitest - Fast unit testing with native ESM support
  • Testing Library - Simple and complete testing utilities
  • MSW - API mocking for development and testing
  • Playwright - Reliable end-to-end testing

Quality & Performance

  • ESLint - Code linting with React 19 and TypeScript rules
  • Prettier - Consistent code formatting
  • Husky - Git hooks for quality enforcement

πŸ“š Documentation

  1. Technology Stack - Detailed overview of all technologies used
  2. Application Structure - Code organization and architecture
  3. TanStack Query Integration - Data fetching patterns
  4. Code Generation - Using Plop for rapid development
  5. E2E Testing - End-to-end testing setup and patterns

Additional Resources

🎯 Core User Flow

  1. Dashboard View: See your time logging status at a glance
  2. Natural Input: Write "Worked on XYZ-123 for 3 hours fixing bugs"
  3. AI Processing: System creates structured time entries automatically
  4. Review & Refine: Check drafts, request changes if needed
  5. One-Click Sync: Ship approved logs directly to Jira

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details on:

  • Code style and standards
  • Development workflow
  • Pull request process
  • Issue reporting

πŸ“„ License

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

πŸš€ What's Next

  • AI-Powered Parsing: Enhanced natural language understanding
  • Team Collaboration: Shared time tracking and reporting
  • Mobile App: Native iOS and Android applications
  • Analytics Dashboard: Advanced reporting and insights

Built with ❀️ by Igor Wnek β€’ Project Repository

Check out the IKcode GitHub profile which contains most of the code related to my YouTube episodes: IKcode

About

TickTock is Jira-time-logging assistant which allows your time tables to be filled in very quickly.

Resources

Contributing

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages