README.md

Clock-Synch

A small app displaying two synchronized clocks.
View Deployment · Report a Bug

Table of Contents

1. About The Project
   • Demo
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Testing
3. License
4. Contact
5. Acknowledgements

About

This app contains two ticking clocks - one digital, one analog. To change the time, the user can click on either clock and select a new time from a TimePicker dialog. Both clocks are kept perfectly in synch with the selected time and with each other.

The clocks are only rendered client-side and are initialized to the user's current time.

Demo

View a working demo hosted on Vercel.

Built With

• React
• Typescript
• Next.js
• Material-UI
• Jest
• React Testing Library

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/tricksterCodess/Clock-Synch.git

2. Install NPM packages

   npm install

3. Run the development server

   npm run dev

4. Go to localhost:3000 to see it in action!

Testing

npm run test

License

Distributed under the MIT License. See LICENSE for more information.

Contact

April Neufeld - @tricksterCodess - [email protected]

Project Link: https://github.com/tricksterCodess/Clock-Synch

Acknowledgements

• Material-Ui Pickers
• react-clock
• react-live-clock
• date-fns
• Best README Template