skilld
All skills
encoredev avatar

/service

@741d95a official
by Encoreencoredev/skills28 stars
5

Implement Encore.ts services and lay out an application using `encore.service.ts`, service directories, systems, and `~encore/clients`. For service boundaries and architecture decisions, use `encore-architecture`.

  • 1 file
  • 3.1 KB
  • Updated 4 weeks ago
  • GitHub

Ask your Agent

Use this Skill: https://skilld.dev/gh/encoredev/skills/service

This session only. Nothing lands on disk.

SKILL.md

≈56 tokens always: the name and description. ≈632 when used: this file.

Encore Service Structure

Instructions

Creating a Service

Every Encore service needs an encore.service.ts file:

// encore.service.ts
import { Service } from "encore.dev/service";

export default new Service("my-service");

Minimal Service Structure

my-service/
├── encore.service.ts    # Service definition (required)
├── api.ts               # API endpoints
└── db.ts                # Database (if needed)

Application Patterns

Single Service

A service can be defined at the application root:

my-app/
├── package.json
├── encore.app
├── encore.service.ts
├── api.ts
├── db.ts
└── migrations/
    └── 001_initial.up.sql

Multi-Service

Each service lives in its own directory:

my-app/
├── encore.app
├── package.json
├── user/
│   ├── encore.service.ts
│   ├── api.ts
│   └── db.ts
├── order/
│   ├── encore.service.ts
│   ├── api.ts
│   └── db.ts
└── notification/
    ├── encore.service.ts
    └── api.ts

Large Application (System-based)

Group related services into systems:

my-app/
├── encore.app
├── commerce/
│   ├── order/
│   │   └── encore.service.ts
│   ├── cart/
│   │   └── encore.service.ts
│   └── payment/
│       └── encore.service.ts
├── identity/
│   ├── user/
│   │   └── encore.service.ts
│   └── auth/
│       └── encore.service.ts
└── comms/
    ├── email/
    │   └── encore.service.ts
    └── push/
        └── encore.service.ts

Service-to-Service Calls

Import other services from ~encore/clients:

import { user } from "~encore/clients";

export const getOrderWithUser = api(
  { method: "GET", path: "/orders/:id", expose: true },
  async ({ id }): Promise<OrderWithUser> => {
    const order = await getOrder(id);
    const orderUser = await user.get({ id: order.userId });
    return { ...order, user: orderUser };
  }
);

Guidelines

  • Services cannot be nested within other services
  • Use ~encore/clients for cross-service calls (never direct imports)
  • Each service can have its own database
  • Service names should be lowercase, descriptive
  • Don't create services just for code organization - use folders instead
  • Use encore-architecture when the service boundaries have not been decided

Source: SKILL.md on GitHub

Third-party checks

No third-party reports yet.

Provenance

Signed by skilld at 741d95a. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 days ago.

Activeupdated 4 weeks ago

Capability

Other metadata
when_to_use
User wants to add or modify an Encore.ts service or microservice, implement an already-chosen service layout, organize service files and directories, group services into system folders, or call another service. Trigger phrases: "add a service", "create a service", "add a microservice", "encore.service.ts", "lay out these services", "service directory", "systems folder", "~encore/clients".

Topics

  • TypeScript
  • encore
  • microservices
  • service-architecture
  • directory-structure
  • domain-driven-design
  • monolith
  • service-boundaries
  • system-design

README badge

README badge for encoredev/skills/service

What it does

Helps architects plan Encore.ts application structure by defining service boundaries, directory layouts, and multi-service patterns. Covers single-service setups, multi-service decomposition with domain boundaries, system-based hierarchies, and service-to-service communication via the `~encore/clients` pattern.

Generated from the current SKILL.md.

Frequently asked

When should I split my Encore app into multiple services?
Split when services have different scaling needs, different deployment cycles, or clear domain boundaries. Keep services together if they share database tables or have tightly coupled logic. Use folders instead of services if you're just organizing code.
Can services be nested within other services?
No. Services cannot be nested within other services in Encore.
How do services communicate with each other?
Import other services from the `~encore/clients` generated package and call their exported APIs directly. Never use direct imports between services.
Do I need a database for every service?
No. Each service can have its own database if needed, but it's optional. Services can be API-only.
What's the minimum required file for an Encore service?
An `encore.service.ts` file that exports a Service instance. You can add `api.ts` and `db.ts` as needed.

Generated from the current SKILL.md. These answers refresh after source changes.