Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 1.8 KB

README.md

File metadata and controls

86 lines (59 loc) · 1.8 KB

TypeLabs

A modern, customizable typing application inspired by monkeytype built with React, TypeScript, and Vite. Practice your typing skills with a beautiful interface and extensive theme customization.

Features

  • 🎨 160+ Built-in themes
  • 🎵 Spotify integration for music playback
  • ⚡️ Fast and responsive typing experience
  • ⌨️ Keyboard shortcuts support
  • Sound effects and volume controls
  • Custom font support

Tech Stack

  • React 18
  • TypeScript
  • Vite
  • Tailwind CSS
  • Zustand (State Management)
  • React Query
  • Shadcn UI Components
  • Spotify Web API

Getting Started

Installation

  1. Clone the repository:
git clone https://github.com/frstycodes/typelabs.git
cd typelabs
  1. Install dependencies:
bun install
  1. Create a .env file in the root directory with your Spotify API credentials:
VITE_SPOTIFY_CLIENT_ID=your_client_id
  1. Start the development server:
bun run dev

Building for Production

To create a production build:

bun run build

Project Structure

typelabs/
├── src/
│   ├── components/    # React components
│   ├── hooks/         # Custom React hooks
│   ├── state/         # Zustand store and state management
│   ├── styles/        # Theme definitions and global styles
│   ├── utils/         # Utility functions
│   └── config/        # Configuration files
├── public/            # Static assets

License

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

Acknowledgments