Getting started developing an app

The quickest way to get started developing an app with Dossier is to use one of the templates.

Astro / SQLite

The dossier-astro-sqlite-app template uses:

  • Astro as the full-stack framework
  • SQLite as the database

In order to keep things as simple as possible, this template doesn't have any auth. Instead there are two different users, an editor principal is used when the project is running in development mode, and a reader principal is used in production. The Dossier web interface is only available in development mode.

npm init using dossierhq/dossier-astro-sqlite-app my-project
cd my-project
git init && git add . && git commit -m '🚀 Created project 🚀'
npm install
npm run build
npm start

You should now have a working app running at http://localhost:4321. To access the Dossier web interface open http://localhost:4321/dossier.

Head over to the GitHub repo to read more.

Next.js / SQLite

The dossier-next-sqlite-app template uses:

In order to keep things as simple as possible, this template doesn't have any auth. I.e. there's no need to login and all users use the same anonymous user. In order to protect the data, in production only read-only published content can be accessed, and the Dossier web interface is disabled.

npm init using dossierhq/dossier-next-sqlite-app my-project
cd my-project
git init && git add . && git commit -m '🚀 Created project 🚀'
npm install
npm run build
npm start

You should now have a working app running at http://localhost:3000. Try to add an entity type to the schema and create some entities.
A new SQLite database will be created in data/database.sqlite. By adding it to Git you can keep the state of Dossier and synchronize it between computers.

Head over to the GitHub repo to read more about options for deploying the app with Fly.io, Netlify or Vercel.