To create a Cadmus editor for your project, you need a backend and a frontend. For the most part, you will end up just customizing the provided code templates, so you do not need advanced programming skills to setup an editor. Of course, a minimal familiarity with the languages and technologies involved is required.

You start with creating backend core libraries, eventually adding your own parts and fragments, with their seeders and tests. Then, you add a couple of services which put all the pieces together, and are consumed by the API layer. Once done, you create the backend API by just assembling the pieces you created with those coming from Cadmus infrastructure.

Then, you create an Angular workspace for your frontend app, eventually adding the editors corresponding to your own parts and fragments. Apart from this, the app is built by just assembling pieces from the Cadmus infrastructure.

👉 Setup a Cadmus development environment and Docker.

Models

Backend

  1. core: core backend solution. At a minimum, this typically includes the core services, even when you are just using existing parts/fragments, unless you prefer to place them directly inside your API.
  2. parts: only if you need to add your own custom parts.
  3. part seeders: only if you need to add your own custom parts.
  4. fragments: only if you need to add your own custom fragments.
  5. fragment seeders: only if you need to add your own custom fragments.
  6. services
  7. API

Frontend

  1. app
  2. libraries
  3. parts: only if you need to add your own custom parts.
  4. fragments: only if you need to add your own custom fragments.

Concepts

Deployment

History

📆 history: this lists the main changes in the software ecosystem during Cadmus development. Refer to this section if you are going to migrate some old code into releases with relevant breaking changes.