Run the Visual Editor

The visual editor is a companion application to the Restura Engine that allows you to visually create and modify the database tables and endpoints found in the restura.schema.json file.

Clone the Restura repository

Currently, there is no standalone application binary for the visual editor. You will need to download and run the application locally.

Start by cloning the repository:

HTTPS

git clone https://github.com/redsky-engineering/restura.git

SSH

git clone git@github.com:redsky-engineering/restura.git

Navigate to the restura-ui directory and run the following command to start the Restura UI:

npm

cd restura
cd apps/restura-ui
npm install
npm run start

pnpm

cd restura
cd apps/restura-ui
pnpm install
pnpm run start

yarn

cd restura
cd apps/restura-ui
yarn install
yarn start

bun

cd restura
cd apps/restura-ui
bun install
bun run start

With the application running, you can now access the visual editor at: http://localhost:3000.

Sign In

When the application opens, you will be prompted to enter a token. The token is the authToken that is set in the restura.config.mjs file.

Click the “SIGN IN” button to login.

Congratulations! You can now start creating and modifying your database tables and endpoints using the visual editor.

Next Steps

Now that you have run the Restura UI, you can:

• Create your first database table - Define tables using the Visual Editor
• Build a standard endpoint - Create a GET endpoint that queries your data

Or dive deeper:

• Explore the schema reference
• Explore the configuration reference