Skip to content
forked from BetaNYC/timer

A web based timer for community board presentations

License

Notifications You must be signed in to change notification settings

mimiflynn/timer

 
 

Repository files navigation

Timer

A web-based timer application built with React and Vite. This timer counts UP and is designed for community boards, toastmaster speeches, and other timing needs.

Features

  • Simple countdown/count-up timer
  • Clean, modern interface using Bootstrap
  • DSEG digital font for authentic timer display
  • Responsive design

For Developers

Prerequisites

  • Node.js (v16 or higher recommended)
  • npm or yarn package manager

Getting Started

  1. Clone the repository

    git clone https://github.com/mimiflynn/timer.git
    cd timer
  2. Install dependencies

    npm install
  3. Start the development server

    npm run dev
    # or
    npm start

    The app will be available at http://localhost:5173

  4. Build for production

    npm run build

    The production-ready files will be in the dist directory.

  5. Preview the production build

    npm run preview
  6. Run tests

    npm test
  7. Lint the code

    npm run lint

Project Structure

timer/
├── public/          # Static assets
├── src/
│   ├── components/  # React components
│   ├── lib/         # Utility functions
│   ├── styles/      # CSS files
│   ├── App.jsx      # Main app component
│   └── main.jsx     # Entry point
├── vite.config.js   # Vite configuration
└── package.json     # Project dependencies

Technologies Used

  • React 18 - UI framework
  • Vite - Build tool and dev server
  • Bootstrap 5 - CSS framework
  • Jest - Testing framework
  • DSEG Font - Digital display font

Contributing

Feel free to fork this project and make pull requests. Contributions are welcome!

Credits

Font: DSEG

Original project: Toastmaster Timer by Guy Ellis

License

See LICENSE file for details.

About

A web based timer for community board presentations

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 88.9%
  • HTML 6.8%
  • CSS 4.3%