Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/theogravity/fastify-starter-turbo-monorepo

A starter project for building an API service using Fastify v5, kysely / postgres, turbo, and pnpm with sample tests and OpenAPI endpoint / database generators to help you build quickly
https://github.com/theogravity/fastify-starter-turbo-monorepo

api boilerplate fastify kysely monorepo npm openapi package postgres rest-api starter starter-project swagger template testcontainers turborepo typescript vitest

Last synced: 3 months ago
JSON representation

A starter project for building an API service using Fastify v5, kysely / postgres, turbo, and pnpm with sample tests and OpenAPI endpoint / database generators to help you build quickly

Awesome Lists containing this project

README 

        
# Fastify Turbo Monorepo Starter



This is a starter project for building an API server using Typescript, Fastify v5 and Kysely with Postgres. 



## Features



- Fastify v5 with Typescript.

- It is setup as a monorepo using [`turbo`](https://turbo.build/) and [`pnpm`](https://pnpm.io/).

- Outputs OpenAPI schema for the API and has a web UI for viewing it.

- A sample REST test is included using Vitest.

- Sample database migrations / repositories are included using Kysely.

- An client SDK package is included to generate typescript client code from the API schema.

- An error handler package is included to handle errors and return a consistent response.

- Code generators using `turbo gen` to create new API endpoints and database tables.

- Publish packages to npm and generate changelogs and releases using [`changesets`](https://github.com/changesets/changesets).



## Libraries and tools used



- [`typescript`](https://www.typescriptlang.org/)

- [`pnpm`](https://pnpm.io/) for package management

- [`changesets`](https://github.com/changesets/changesets) for version and changelogs

- [`commitlint`](https://commitlint.js.org/) for commit message linting

- [`turbo`](https://turbo.build/) for monorepo management

- [`fastify`](https://www.fastify.io/) for the API server framework

- [`hash-runner`](https://github.com/theogravity/hash-runner) for caching builds

- [`kysely`](https://kysely.dev/) for the database query builder

- [`postgres`](https://www.postgresql.org/) + pgAdmin for the database

- [`testcontainers`](https://www.testcontainers.org/) for testing with a sandboxed postgres instance

- [`vitest`](https://vitest.dev/) for endpoint testing

- [`loglayer`](https://github.com/theogravity/loglayer) for formatted logging

- [`biome`](https://biomejs.dev/) for linting and formatting

- [`syncpack`](https://jamiemason.github.io/syncpack/) for keeping package versions in sync

- [`Hey API`](https://heyapi.vercel.app/) for generating the backend SDK using the generated OpenAPI schema from the backend



## Setup



- [Install docker](https://docs.docker.com/engine/install/)

- [Install pnpm](https://pnpm.io/installation)

- `pnpm install turbo --global`

- `pnpm install`

- Copy `apps/backend/.env.example` to `apps/backend/.env`



Start local postgres server:



`docker compose up -d`



Perform database migrations:



`pnpm db:migrate:lastest`



In Github settings (to publish packages and changelogs):

- Edit `.changeset/config.json` to your repository

- `Code and Automation > Actions > Workflow permissions`

    * `Read and write permissions`

    * `Allow Github Actions to create and approve pull requests`

- `Secrets and variables > Actions`

    * `Repository Secrets > Actions > create NPM_TOKEN > your npm publish token`



## Development



`turbo watch dev`



- API server: http://localhost:3080

- OpenAPI docs: http://localhost:3080/docs

- PGAdmin: http://localhost:5050



## Testing



Make sure docker is running as it uses `testcontainers` to spin up a

temporary postgres database.



`turbo test`



## Build



`turbo build`



## Generate scaffolding



Generators for the following:



- New API endpoints + tests

- Database tables and repositories



`turbo gen`



## Database migrations



- Create a migration: `pnpm db:create`

- Run migrations: `pnpm db:latest`

- Rollback migrations: `pnpm db:undo`



## Update all dependencies



`pnpm syncpack:update`



## Development workflow / Add a new CHANGELOG.md entry + package versioning



- Create a branch and make changes.

- Create a new changeset entry: `pnpm changeset`

- Commit your changes and create a pull request.

- Merge the pull request 

- A new PR will be created with the changeset entry/ies.

- When the PR is merged, the package versions will be bumped and published and the changelog updated.



**note: To publish a package, `private: false` must be set in the package.json**



## Troubleshooting



### turbo watch dev failing



```

• Packages in scope: @internal/backend, @internal/backend-client, @internal/backend-errors, @internal/tsconfig

• Running dev in 4 packages

• Remote caching disabled

  × failed to connect to daemon

  ╰─▶ server is unavailable: channel closed

```



Try:



`turbo daemon clean`



Then try running `turbo watch dev` again.



If you get:



```

• Packages in scope: @internal/backend, @internal/backend-client, @internal/backend-errors, @internal/tsconfig

• Running dev in 4 packages

• Remote caching disabled

  × discovery failed: bad grpc status code: The operation was cancelled

```



Wait a few minutes and try again.



Related:



- https://github.com/vercel/turborepo/issues/8491