Thanks to visit codestin.com
Credit goes to github.com

Skip to content

zoonk/zoonk

Zoonk logo (a smiley brain) on the first line. Below it says 'learn anything with interactive courses'

Web app for learning anything using AI.

Waitlist

Caution

Early Development Notice

This project is still in early development and not ready for use. We’re actively working to make it available as soon as possible.

As we progress, we’ll open it for testing and contributions. Star this repository or follow us on social media to stay updated.

Table of Contents

Getting Started

Prerequisites

  • Node.js v22
  • pnpm v10
  • PostgreSQL v17

We recommend using mise to manage your Node.js and pnpm versions.

Turborepo

We're using Turborepo as our monorepo tool to manage multiple packages and applications within a single repository. If you haven't already, please install Turborepo globally:

pnpm add turbo --global

Remote Caching

We're using Vercel's Remote Caching to speed up our Turborepo tasks. To enable remote caching, authenticate the Turborepo CLI with your Vercel account:

turbo login

Then, link to the remote cache:

turbo link

Installation

  • pnpm install to install dependencies for all apps and packages
  • Check out the @zoonk/db package README for database setup instructions

Local Development

  • turbo dev to start the development server
  • turbo build to create a production build
  • turbo lint to run linting
  • turbo typecheck to run TypeScript type checking
  • turbo test to run tests with Vitest

Adding dependencies

Check the Turborepo guide for managing dependencies.

You can add a dependency to a specific package or app by running:

# package
pnpm add <package-name> --filter=@zoonk/ui

# app
pnpm add <package-name> --filter=main

Adding shadcn components

To add components, run the add command in the path of our UI package:

cd packages/ui
pnpm dlx shadcn@canary add [COMPONENT]

Social Media

Supporters

People who supported this project:

Sponsor this project