Giter Club home page Giter Club logo

directus-sync-auto-example's Introduction

Directus + auto-sync of schema/collections - an example setup

This is a result of my own testings with Directus, where I wanted a boilerplate setup with schema changes reflected as files so they can be version controlled and deployed on various stage/prod environments.

How it works

  1. Simple Directus setup with Docker and Docker Compose for local development.
  2. Adding directus-extension-sync and directus-sync, which offers handy CLI for managing and synchronizing the schema and collections within Directus.
  3. Creating a custom extension (directus-extension-sync-auto) that executes npx directus-sync pull/push on schema change and startup hooks.

Use env vars to toggle auto push/pull

The custom extension introduces three new environment variables:

  • DIRECTUS_SYNC_AUTO_PULL - set to true to auto-backup schemas and collections on changes in UI.
  • DIRECTUS_SYNC_AUTO_PUSH - set to true to auto-sync backed-up schemas and collections on server start.
  • DIRECTUS_SYNC_CONFIG_PATH - set to any custom config file for directus-sync. See all options available in their repo.

Typically, you would have both auto-pull and auto-push enabled for local development, but only auto-push on stage/prod.

directus-sync-auto-example's People

Contributors

denkan avatar

Stargazers

jon โš avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.