Quickstart

Quickstart

Get Cooren on your machine fast. Then inspect the API and route groups.

You should be ready to explore the API in a few minutes.

Before you start

This guide assumes you already know:

• Git and the terminal

• Environment variables

• HTTP, REST, and JSON

• Basic TypeScript workflows

Basic setup for Git, Bun, Node.js, editors, and general web concepts is out of scope here.

Requirements

Make sure you have:

• Git

• Bun

• A REST client like Postman, Insomnia, or Bruno

• A TypeScript-friendly editor

Get the code

1

Clone the repository

git clone https://github.com/CoorenLabs/Cooren.git
cd Cooren

2

Install dependencies

bun install

3

Start the API

Run the Bun start command defined by the repository.

Once the server is up, continue with the checks below.

4

Open the API docs

Visit:

http://localhost:<port>/docs

This is the fastest way to inspect available endpoints.

Verify the server

Check the root endpoint first:

curl http://localhost:<port>/

You should get a JSON response with status or metadata.

Then open:

• /docs for the OpenAPI UI

• / for the base metadata response

Route groups

Cooren mounts providers under a few top-level prefixes:

• /anime

• /manga

• /movie-tv

• /music

If the server is running, those groups should appear in the API docs.

How the project is organized

The codebase is split into three main areas:

• src/core Config, logging, cache, helpers, and route mapping

• src/providers Provider implementations grouped by category

• src/index.ts App setup, CORS, path normalization, and route registration

What happens on startup

When Cooren boots, it:

1. Validates configuration

2. Configures CORS and request handling

3. Registers provider routes

4. Exposes /docs

5. Exposes /

Need deeper background?

Use the official docs for core dependencies:

• Bun

• TypeScript

• Node.js

• Elysia

• Elysia CORS

• Elysia OpenAPI

• Axios

• Cheerio

• Zod

• Upstash Redis

Next step

Once the API is running, open /docs and test one provider route end to end.