Migrating your app to framework - `v1.0`

All Gadget framework versions prior to 1.0 will be deprecated early next year. On March 1, 2025, all development environments on deprecated versions will be automatically migrated to the latest framework version, and production environments will be paused. To avoid disruptions, upgrade your apps to the latest framework version before March 1st.

Added support for multi-environments and source-control

With framework v1.0 Gadget is introducing the ability for users to create multiple development environments within an application and allows developers to use Git-based source control to manage all of their application code and configuration.

To learn how to upgrade your application, check out our framework upgrade guide.

What is changing?

To support the new additions with v1.0, your Gadget application will also change the file structure of your application along with a couple of UI updates within Gadget.

File structure

The way your full-stack app file directory is now represented has changed.

- The backend of your application is now represented within the api folder which contains all your models, actions and routes

- Model folders will be nested under api/models

Before migration: user
After migration: api/models/user

- Model actions will nested under their respective model, in the folder actions: api/models/exampleModel/actions/create.js

Before migration: user/actions/create.js
After migration: api/models/user/actions/create.js

- Global actions will be renamed to actions and moved under the api folder: api/actions/exampleGlobalAction.js

Before migration: globalActions/fetch.js
After migration: api/actions/fetch.js

- The existing routes folder containing HTTP routes will be moved under the api folder

Before migration: routes
After migration: api/routes

- The frontend folder of your application is now renamed as web

Showcasing the migration changes of the file structure for Gadget apps upgrading to v1

What we migrate for you

All import paths will update to ensure your app is not broken.
Any other files or folders will not be renamed with the migration changes.

UI update

We have introduced a new UI to support the following changes with framework v1.0.

Environment selector to navigate through environments and create multiple development environments

Access control panel now located at the bottom of the nav outside the previous models section
Global actions are now not directly named in the product but can be created within the api/actions folder

What to do after migrating your app

Test out your app and ensure everything is functional as expected.
Ensure all files are in the correct placement with the changes described above.
Once you're satisfied with the changes deploy your application to production.