I've long thought that the difference between a professional and an amateur is 'the ability to consistently perform well,' and as a result, I've become very interested in productivity tools like the Pomodoro Timer. This, combined with my serious intention to study development, has led me to my current project.
I'm taking this project quite seriously, but I'm not in a paid developer and development is purely a hobby that I can only work on in my spare time. Due to this, updates may be slow and even server downtime can occur. However, this project is alive and I intend to continue it as much as I can. Thank you for taking an interest in this project.
Pipe Timer is an app designed to enhance productivity by allowing users to freely combine timers with push notifications. Users can create a series of "timers", referred to as "routines", to plan out regular and segmented work and rest periods(or something you want).
When each timer expires, a desktop notification is sent to alert the user. You can use Pipe Timer either way—for simple, straightforward use without signing up, or by registering as a member to enjoy the additional feature of saving timers and routines on the server. This allows users to utilize their routines in different environments without having to reconfigure them.
You can either use Pipe Timer directly or host it locally using Docker.
The following tools are essentially required to run the app properly.
-
Clone the repository.
git clone https://github.com/yidoyoon/pipe-timer.git cd pipe-timer -
Generate two dummy certificates for HTTPS server operation using mkcert. The following command installs the packages required for mkcert installation and execution, and runs a script to generate a certificate. The script is located at
./shared/helper/generate-local-certs.sh, and you can modify it if needed.pnpm dev:cert:init
-
Set the essential environment variables required for app operation. The file providing these environment variables is located at
backend/env/.development.env. SetHOST_URLaccording to your environment and domain.# Nodemailer(Required) EMAIL_SERVICE= EMAIL_AUTH_USER= EMAIL_AUTH_PASSWORD= # Sendgrid SENDGRID_KEY= # Backend(Docker compose) API_PORT_0= API_PORT_1= API_PORT_2= API_PORT_3= # Frontend(Docker compose) FRONT_PORT_0= FRONT_PORT_1= FRONT_PORT_2= # MySQL DB DB_NAME= DB_USERNAME= DB_PASSWORD= # Access token and session secret JWT_SECRET= SESSION_SECRET= # Swagger ID, PASSWORD SWAGGER_ID= SWAGGER_PASSWORD= # Docker tag DOCKER_REGISTRY=
-
Run
pnpm dev:compose:up
-
Access the address set in
HOST_URLon port4000through your browser. Example:https://localhost:4000
- Add monitoring infrastructure
- Resource monitoring
- Log collection
- Usage statistics feature
- Timer data sharing
- Direct sharing on the web
- Export to file
- Smartphone platform optimization
Distributed under the GPL-3.0