dossierhq

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 51)

The headless CMS toolkit

dossierhq Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Dossier

[![Node CI](https://github.com/dossierhq/dossierhq/actions/workflows/nodejs.yml/badge.svg)](https://github.com/dossierhq/dossierhq/actions/workflows/nodejs.yml) [![Benchmark](https://github.com/dossierhq/dossierhq/actions/workflows/benchmark.yml/badge.svg)](https://github.com/dossierhq/dossierhq/actions/workflows/benchmark.yml)

Dossier enables you to build solutions where you’re in full control of the content. By bringing your own auth (authentication and authorization), database and backend, you can build a headless Content Management System (CMS) and integrate it with your app.

For more information about Dossier, head over to [dossierhq.dev](https://www.dossierhq.dev). The rest of this readme is focused on developing and contributing to Dossier itself.

If you just want to get started using Dossier, these destinations might get you there faster:

- [Dossier Playground](https://playground.dossierhq.dev/) - use Dossier in a browser
- [dossier-next-sqlite-app](https://github.com/dossierhq/dossier-next-sqlite-app) - a template using Dossier, Next.js and SQLite
- [dossier-astro-sqlite-app](https://github.com/dossierhq/dossier-astro-sqlite-app) - a template using Dossier, Astro and SQLite

## Published packages

| Package                           | Version                                                                                                                                      | Folder                                                              |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `@dossierhq/better-sqlite3`       | [![npm version](https://badge.fury.io/js/@dossierhq%2Fbetter-sqlite3.svg)](https://badge.fury.io/js/@dossierhq%2Fbetter-sqlite3)             | [libraries/better-sqlite3](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/better-sqlite3/)             |
| `@dossierhq/cloudinary`           | [![npm version](https://badge.fury.io/js/@dossierhq%2Fcloudinary.svg)](https://badge.fury.io/js/@dossierhq%2Fcloudinary)                     | [libraries/cloudinary](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/cloudinary/)                     |
| `@dossierhq/core`                 | [![npm version](https://badge.fury.io/js/@dossierhq%2Fcore.svg)](https://badge.fury.io/js/@dossierhq%2Fcore)                                 | [libraries/core](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/core/)                                 |
| `@dossierhq/core-vitest`          | [![npm version](https://badge.fury.io/js/@dossierhq%2Fcore-vitest.svg)](https://badge.fury.io/js/@dossierhq%2Fcore-vitest)                   | [libraries/core-vitest](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/core-vitest/)                   |
| `@dossierhq/database-adapter`     | [![npm version](https://badge.fury.io/js/@dossierhq%2Fdatabase-adapter.svg)](https://badge.fury.io/js/@dossierhq%2Fdatabase-adapter)         | [libraries/database-adapter](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/database-adapter/)         |
| `@dossierhq/design`               | [![npm version](https://badge.fury.io/js/@dossierhq%2Fdesign.svg)](https://badge.fury.io/js/@dossierhq%2Fdesign)                             | [libraries/design](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/design/)                             |
| `@dossierhq/graphql`              | [![npm version](https://badge.fury.io/js/@dossierhq%2Fgraphql.svg)](https://badge.fury.io/js/@dossierhq%2Fgraphql)                           | [libraries/graphql](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/graphql/)                           |
| `@dossierhq/integration-test`     | [![npm version](https://badge.fury.io/js/@dossierhq%2Fintegration-test.svg)](https://badge.fury.io/js/@dossierhq%2Fintegration-test)         | [libraries/integration-test](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/integration-test/)         |
| `@dossierhq/leaflet`              | [![npm version](https://badge.fury.io/js/@dossierhq%2Fleaflet.svg)](https://badge.fury.io/js/@dossierhq%2Fleaflet)                           | [libraries/leaflet](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/leaflet/)                           |
| `@dossierhq/pg`                   | [![npm version](https://badge.fury.io/js/@dossierhq%2Fpg.svg)](https://badge.fury.io/js/@dossierhq%2Fpg)                                     | [libraries/pg](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/pg/)                                     |
| `@dossierhq/postgres-core`        | [![npm version](https://badge.fury.io/js/@dossierhq%2Fpostgres-core.svg)](https://badge.fury.io/js/@dossierhq%2Fpostgres-core)               | [libraries/postgres-core](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/postgres-core/)               |
| `@dossierhq/postgres-tools`       | [![npm version](https://badge.fury.io/js/@dossierhq%2Fpostgres-tools.svg)](https://badge.fury.io/js/@dossierhq%2Fpostgres-tools)             | [libraries/postgres-tools](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/postgres-tools/)             |
| `@dossierhq/react-components`     | [![npm version](https://badge.fury.io/js/@dossierhq%2Freact-components.svg)](https://badge.fury.io/js/@dossierhq%2Freact-components)         | [libraries/react-components](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/react-components/)         |
| `@dossierhq/react-components2`    | [![npm version](https://badge.fury.io/js/@dossierhq%2Freact-components2.svg)](https://badge.fury.io/js/@dossierhq%2Freact-components2)       | [libraries/react-components2](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/react-components2/)       |
| `@dossierhq/server`               | [![npm version](https://badge.fury.io/js/@dossierhq%2Fserver.svg)](https://badge.fury.io/js/@dossierhq%2Fserver)                             | [libraries/server](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/server/)                             |
| `@dossierhq/sql.js`               | [![npm version](https://badge.fury.io/js/@dossierhq%2Fsql.js.svg)](https://badge.fury.io/js/@dossierhq%2Fsql.js)                             | [libraries/sql.js](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/sql.js/)                             |
| `@dossierhq/sqlite-core`          | [![npm version](https://badge.fury.io/js/@dossierhq%2Fsqlite-core.svg)](https://badge.fury.io/js/@dossierhq%2Fsqlite-core)                   | [libraries/sqlite-core](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/sqlite-core/)                   |
| `@dossierhq/typescript-generator` | [![npm version](https://badge.fury.io/js/@dossierhq%2Ftypescript-generator.svg)](https://badge.fury.io/js/@dossierhq%2Ftypescript-generator) | [libraries/typescript-generator](https://raw.githubusercontent.com/dossierhq/dossierhq/main/libraries/typescript-generator/) |

## Development dependencies

- Use [mise](https://mise.jdx.dev/) to install the tools in `.tools-versions`
- `brew install pgcli` (optional, for Postgres access)
- `brew install gnuplot` (for benchmarking)
- `npx playwright install` (for installing browsers for Playwright testing)

## Getting started

- `pnpm i` to install dependencies.
- In `tools/generic-tools/`:
  - By default the databases (test and example databases on PostgreSQL) are configured in Docker. To use another db set the env variable `HOST_ROOT_DATABASE_URL`
  - `npm run db:start` (only if running db in Docker)
  - `npm run db:ensure-dbs`
  - `npm run db:make-users:superuser`
  - `npm run db:migrate:all`
  - `npm run db:make-users:no-superuser`
- `pnpm run build`

## Dev container / Github Code Spaces

- Start dev container
- The script [post-create.sh](./.devcontainer/scripts/post-create.sh) runs automatically on first run
- When done, restart your shell since it sets up environment variables
- For root access to the Postgres database, run `psql "$HOST_ROOT_DATABASE_URL"` or `pgcli "$HOST_ROOT_DATABASE_URL"`

## Upgrade dependencies

- Run `pnpm tools:update`
  - Update `packageManager` in `package.json` to match the version of `pnpm` you have installed
- Run `pnpm deps:update-interactive`
- Upgrade Deno dependencies in the 3 `import-map.json` files
- Run `(cd tools/generic-tools && npm run deno:reload-dependencies:all)`
- Upgrade the postgres version in `./docker-compose.yml`

## Publish packages

- When making changes to published packages, create a changeset using `pnpm changeset:add`
- The [release workflow](./.github/workflows/release.yml) will automatically open a PR to bump the versions
- Merge the PR to publish the packages

## Ports

- 3000: examples/tutorial
- 3001: examples/next-web
- 3002: apps/playground
- 3003: apps/blog
- 3004: apps/playground2
- 4321: examples/astro
- 4322: examples/astro (HMR)
- 5173: examples/tutorial
- 6006: libraries/react-components
- 6007: libraries/design
- 6008: libraries/react-components2
- 9000: libraries/libsql - admin entity
- 9001: libraries/libsql - advisory lock
- 9002: libraries/libsql - advisory lock
- 9003: libraries/libsql - published entity
- 9004: libraries/libsql - schema
- 9005: libraries/libsql - changelog
- 9006: libraries/libsql - sync source
- 9007: libraries/libsql - sync target

dossierhq

dossierhq Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

dossierhq

dossierhq Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README