📝 Schedule your time in an instant.

Try now · Report bug · Contribute your code

Overview

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Report a bug
5. Contributing to Picktime
6. License

📌 About The Project

Picktime is a tool that helps you easily schedule your event

• User-friendly interface on all devices.

• Minimal design

• Inspired by tha famous website When2meet

(back to top)

📌 Getting Started

This is how you set up your project locally. To use picktime online, please visit here.

• Prerequisites

  we use pnpm as the node package manager, but feel free to use the one you like.

  • pnpm

    npm install pnpm -g

• Installation

  1. Clone the repo

     git clone https://github.com/yuaanlin/pick-time.io.git

     or

     git clone [email protected]:yuaanlin/pick-time.io.git

  2. Install Pnpm packages

  • pnpm

    pnpm install

  3. Start the development server
  • pnpm

    pnpm dev

  1. Enjoy picktime at http://localhost:3000

(back to top)

📌 Usage

• Event creater

  • Simply create your event by entering the title, possible dates and time.

  • Share the RSVP link with your friend!

• Event attendant

  • Visit the event exclusive picktime link to scheduleyour availability.

  • Check other's availability anytime with a simple click !

(back to top)

📌 Report a bug

• Please follow the below guidelines if you would like to report a bug:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest main or development branch in the repository.

  3. Isolate the problem — create a reduced test case and a live example.

  Example:

  Short and descriptive example bug report title

  A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

  <url> - a link to the reduced test case

  Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

(back to top)

📌 Contributing to Picktime

• Follow this process if you'd like your work considered for inclusion in the picktime

  1. Fork the project, clone your fork, and configure the remotes:

     # Clone your fork of the repo into the current directory
     git clone https://github.com/yuuanlin/pick-time.io
     # Navigate to the newly cloned directory
     cd pick-time.io
     # Assign the original repo to a remote called "upstream"
     git remote add upstream https://github.com/yuuanlin/pick-time.io

  2. If you cloned a while ago, get the latest changes from upstream:

     git checkout <dev-branch>
     git pull upstream <dev-branch>

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

     git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

     git pull [--rebase] upstream <dev-branch>

  6. Push your topic branch up to your fork:

     git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description.

  
  

  IMPORTANT: By submitting a patch, you agree to allow us to license your work under the same license as that used by picktime

📌 License

• Picktime is distributed under the MIT License. See LICENSE for more information.

(back to top)