Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 1 addition & 79 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1 @@
# ClankerLoop

A monorepo containing a Next.js web app and Cloudflare Workers backend. Check it out at [ClankerLoop.com](https://ClankerLoop.com).

![Demo](public/demo.gif)

## Prerequisites

- [Bun](https://bun.sh/) v1.1.10+
- [Node.js](https://nodejs.org/) v18+
- PostgreSQL database

## Setup

1. **Install dependencies**

```sh
bun install
```

2. **Configure environment variables**

```sh
cp apps/web/.env.example apps/web/.env
cp apps/backend/.env.example apps/backend/.env
cp packages/db/.env.example packages/db/.env
```

Fill in the values in each `.env` file.

3. **Set up the database**

```sh
bun run db:generate
bun run db:migrate
```

## Development

Start all apps:

```sh
bun run dev
```

Or run a specific app:

```sh
# Web app (Next.js)
bun run dev --filter=web

# Backend (Cloudflare Workers)
bun run dev --filter=backend
```

## Other Commands

```sh
bun run build # Build all apps
bun run lint # Lint all apps
bun run lint:fix # Lint and fix issues
bun run format # Format code with Prettier
bun run check-types # Type check all apps
bun run db:studio # Open Drizzle Studio
```

## Project Structure

```
apps/
web/ # Next.js frontend
backend/ # Cloudflare Workers API

packages/
db/ # Drizzle ORM database layer
api-types/ # Shared API types
eslint-config/ # ESLint configuration
typescript-config/ # TypeScript configuration
```
this is working properly