Skip to content

zoonk/zoonk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

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

Web app for creating interactive courses 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 or higher
  • pnpm v10 or higher
  • PostgreSQL v17 or higher

You can install multiple Node.js and pnpm versions using mise.

Installation

  • pnpm install to install dependencies
  • cp .env.example .env and fill in the required environment variables

PostgreSQL Setup

For macOS users, you can install PostgreSQL using Homebrew:

brew install postgresql
brew services start postgresql

Then, create a new database:

createdb zoonk

Update the DATABASE_URL in your .env file with your PostgreSQL credentials. It will look something like this:

DATABASE_URL="postgresql://USER:PASSWORD@localhost:5432/zoonk"

Prisma Setup

Run the following commands to set up Prisma:

  • pnpm prisma generate to generate Prisma client
  • pnpm db:migrate to run migrations and set up the database
  • pnpm db:reset to reset the database (this will erase all data)
  • pnpm prisma migrate dev --create-only to create a new migration without applying it

Local Development

  • pnpm dev to start the development server
  • pnpm build to create a production build
  • pnpm start to start the production server
  • pnpm lint to run linting
  • pnpm format to format the code according to our Biome configuration
  • pnpm prisma studio to open Prisma Studio and inspect your database
  • pnpm type-check to run TypeScript type checking
  • pnpm test to run tests with Vitest
  • pnpm i18n to check for missing or unused i18n keys

Social Media

Supporters

People who supported this project:

Sponsor this project