https://github.com/kiritocode1/ensiessay

https://github.com/kiritocode1/ensiessay

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kiritocode1/ensiessay
• Owner: kiritocode1
• Created: 2025-11-26T15:41:31.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-12-03T20:44:16.000Z (8 months ago)
• Last Synced: 2025-12-11T13:57:48.038Z (8 months ago)
• Language: TypeScript
• Size: 123 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## EnsiEssay – Creator Intelligence Workspace

EnsiEssay is an authenticated workspace for YouTube creators that turns channel data, comments, and market signals into an actionable "essay" on what to publish next. The motive is to move beyond dashboards and give a fast read on audience sentiment, content performance, and market direction in one place.

## Architecture

-   **App router layout**

    -   `app/(auth)`: sign-in / sign-up surfaces using Better Auth.

    -   `app/(app)`: authenticated workspace (`dashboard`, `comments`, `market`) behind a proxy guard.

-   **Auth**

    -   [`better-auth`](https://www.better-auth.com/) with a Google OAuth provider and YouTube scopes.

    -   Server config + session helpers in `lib/auth/` and API route in `app/api/auth/[...better-auth]/route.ts`.

-   **Effect-style service layer**

    -   Pure, typed service modules in `lib/effect/` (`youtube.service.ts`, `comment-analysis.service.ts`, `market.service.ts`, `user-data.service.ts`) with mocked implementations.

    -   A small `runtime` helper that is ready to be swapped to real [`effect`](https://effect.website) usage later.

-   **Routing protection**

    -   `proxy.ts` enforces that all `/(app)` routes require an authenticated session and redirects to `/(auth)/sign-in` otherwise.

```mermaid

flowchart LR

    U[Visitor] --> A[auth app]

    A -->|Google OAuth via Better Auth| B[Session in lib/auth/server]

    B --> P[proxy.ts guard]

    P -->|authenticated| W[workspace app]

    P -->|unauthenticated| A

    W --> D[Dashboard page]

    W --> C[Comments page]

    W --> M[Market page]

    D & C & M --> S[(lib/effect services)]

    S -->|mocked / future Effect| Y[youtube.service.ts, comment-analysis.service.ts, market.service.ts, user-data.service.ts]

```

## Packages

-   **Runtime / framework**

    -   `next` (App Router), `react`, `react-dom`.

-   **Auth**

    -   `better-auth` and `better-auth/next-js` for server + client adapters.

-   **Environment**

    -   `@t3-oss/env-core` and `zod` for a typed `env.ts` schema (Google OAuth keys, `NODE_ENV`, etc.).

-   **Experiments / services**

    -   `effect` (planned) for future effectful service implementations behind the existing typed interfaces in `lib/effect/`.

## Setup

1. **Install dependencies**

    ```bash

    pnpm install

    ```

2. **Environment variables**

    Configure a `.env.local` compatible with `env.ts`:

    - `NODE_ENV`

    - `GOOGLE_CLIENT_ID`

    - `GOOGLE_CLIENT_SECRET`

    - Any additional Better Auth or YouTube-related secrets you introduce later.

3. **Run the dev server**

````bash

pnpm dev

    ```

    Then open `http://localhost:3000`.

## Development notes

-   Client-side auth flows use the Better Auth React client in `lib/auth/client.ts` from the `app/(auth)` pages.

-   The `lib/effect/*` modules currently return mocked data; you can replace their internals with real Effect programs without changing the UI layer.

-   Keep new modules typed and avoid `any` / `undefined` in TypeScript; extend the existing domain types instead.

## Further reading

-   `packages-and-setup.md`: short reference for core dependencies and pnpm commands.

````