Clucker Clocker

Clock in, cluck out.

A minimal time tracker for when you have to track time but don't want all the bells and whistles. Built with Next.js 14 (App router), React Query, Auth.js, Prisma, PostgreSQL, Tailwind CSS, shadcn/ui.

Roadmap

• Functionality for non-registered users
• Offline functionality
• Import project names from Clockify
• Sync time entries to Clockify
  • Manually?
  • Cron job daily?
  • On save?

Run it locally

Prerequisites

• Create a Google API client ID and secret in the Google Developers Console.
• You will need a PostgreSQL database.
  • With Railway go to https://railway.app/new and click Deploy PostgreSQL, then click on the Variables tab and grab the DATABASE_URL.
  • Or, assuming you have PostgreSQL installed, you could instead create a local database for development with this command:

    • createdb mydatabase
      

    • Then you can connect to it: DATABASE_URL=postgresql://postgres:[YOUR_PASSWORD]@localhost:5432/mydatabase
  • Or, assuming you have Docker installed, you could run Postgres in a Docker container:

    • docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_DB=mydatabase -p 5432:5432 -d postgres
      

    • Then you can connect to it: DATABASE_URL=postgresql://postgres:mysecretpassword@localhost:5432/mydatabase

Installation

1. Clone the repo

   git clone https://github.com/james-langridge/clucker-clocker.git
   

2. Install NPM packages

   npm install
   

3. Copy .env.local.example to .env.local and add your API key.

   cp .env.local.example .env.local
   

4. Once you have a Postgres DB running somewhere, and the DATABASE_URL env var set, run the Prisma Migrate command:

   npx prisma migrate dev
   

5. Start the development server:

   npm run dev
   

Deploy your own

If you cloned the repo, deploying to Vercel is simple: https://vercel.com/new

You can also clone and deploy this project on Vercel using the button below.

See the Next.js deployment documentation for more details.

License

Code distributed under the MIT License.