Skip to content

dudubarwine/tipsync

Repository files navigation

TipSync

Welcome to the TipSync App! This web application is designed to streamline the shift management process and tip distribution for our team at Dudu Bar & Wine. Built with React, TypeScript, and Vite, this app enhances efficiency and ensures fair practices in employee compensation.

Table of Contents

Features

  • Employee Time Tracking: Record start and finish times for each shift.
  • Tip Calculation: Easily calculate total tips and distribute them based on hours worked.
  • User-Friendly Interface: A clean and intuitive interface for easy navigation and management.
  • Real-time Updates: Ensure that all information is up-to-date and accessible to management.

Technologies

This project utilizes the following technologies:

  • React: A JavaScript library for building user interfaces.
  • TypeScript: A typed superset of JavaScript that enhances code quality and maintainability.
  • Vite: A fast development build tool that provides a smooth development experience.

Installation

To get started with the TipSync, follow these steps:

  1. Clone the repository:
    git clone https://github.com/dudubarwine/tipsync.git
  2. Navigate to the project directory:
    cd tipsync
  3. Install the dependencies:
    npm install

Usage

To run the application locally, use the following command:

npm run dev

Open your browser and navigate to http://localhost:3000 to access the app.

Contributing

We welcome contributions to enhance the functionality and usability of the app. Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch:
git checkout -b @feature/<YourFeature>
  1. Commit your changes:
git commit -m "<Add your message here>"
  1. Push the branch:
git push origin @feature/<YourFeature>
  1. Submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

About

A web application built with React, TypeScript, and Vite for managing shifts and tip distribution at Dudu Bar & Wine. This app streamlines the process of tracking employee hours, calculating tips, and ensuring fair distribution based on individual shifts.

Resources

License

Stars

Watchers

Forks

Contributors