From 9625935a9b6892e4e993e139fe0d382c74e114ed Mon Sep 17 00:00:00 2001 From: Adria Navarro Date: Tue, 5 Dec 2023 11:03:52 +0100 Subject: [PATCH] Add readme --- packages/server/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 packages/server/README.md diff --git a/packages/server/README.md b/packages/server/README.md new file mode 100644 index 0000000000..939a377404 --- /dev/null +++ b/packages/server/README.md @@ -0,0 +1,14 @@ +# Budibase server project + +This project contains all the server specific logic required to run a Budibase app + +## App migrations + +A migration system has been created in order to modify existing apps when breaking changes are added. These migrations will run on the app startup (both from the client side or the builder side), blocking the access until they are correctly applied. + +### Create a new migration + +In order to add a new migration: + +1. Run `yarn add-app-migration [title]` +2. Write your code on the newly created file