Skip to content

alexfriesen/zeity

Repository files navigation

Zeity

Zeity is a time tracking app with a focus on UX.

Important

This project is in an early stage of development.

Getting Started

Prerequisites

  • Node.js
  • pnpm

Running the Application

To start the development server, run:

pnpm dev

Building the Application

To build the application for production, run:

pnpm build

Linting

To lint the code, run:

pnpm lint

Testing

To run the tests, run:

pnpm test

Running via Docker

To run Zeity using the official Docker image, make sure you have Docker and Docker Compose installed.

The provided docker-compose.yml is preconfigured to use the image alexfriesen/zeity:main from Docker Hub.

To start the application, run:

docker compose up

To stop the running Docker containers, run:

docker compose down

Once the application is running, you can access it at http://localhost:3000.

Environment Variables

ZEITY_DATABASE_URL=
ZEITY_MAILER_SMTP_HOST=
ZEITY_MAILER_SMTP_PORT=
ZEITY_S3_END_POINT=
ZEITY_S3_ACCESSKEY=
ZEITY_S3_SECRETKEY=
ZEITY_S3_BUCKET=
ZEITY_SESSION_PASSWORD= // 32 character long password

Optional Variables:

# Google OAuth
ZEITY_OAUTH_GOOGLE_CLIENT_ID=
ZEITY_OAUTH_GOOGLE_CLIENT_SECRET=
# Apple OAuth
ZEITY_OAUTH_APPLE_CLIENT_ID=
ZEITY_OAUTH_APPLE_CLIENT_SECRET=
# Microsoft OAuth
ZEITY_OAUTH_MICROSOFT_CLIENT_ID=
ZEITY_OAUTH_MICROSOFT_CLIENT_SECRET=

Releases

No releases published

Contributors 4

  •  
  •  
  •  
  •  

Languages