An open API service indexing awesome lists of open source software.

https://github.com/alexfriesen/zeity

time tracking app with great UX
https://github.com/alexfriesen/zeity

nuxt open-source productivity productivity-app productivity-tool time time-tracker timer vue webapp

Last synced: about 1 month ago
JSON representation

time tracking app with great UX

Awesome Lists containing this project

README

          

# 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:

```sh
pnpm dev
```

### Building the Application
To build the application for production, run:

```sh
pnpm build
```

### Linting
To lint the code, run:

```sh
pnpm lint
```

### Testing
To run the tests, run:

```sh
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:
```sh
docker compose up
```

To stop the running Docker containers, run:
```sh
docker compose down
```

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

### Environment Variables

```env
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:
```env
# 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=
```