/skaffolder-vscode-extension

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

GitHub Workflow Status GitHub License

Extension Gif

Skaffolder Generator

This extension allows to create, edit and manage a Skaffolder project.

It allows to create web and mobile applications starting from the technical documentation of database models, APIs and pages.

The documentation can be defined from the Skaffolder web interface having a free Skaffolder account or from the openapi.yaml file that extends the OpenAPI 3.0 standards. This exension allows to edit the openapi file from a visual interface according to the Skaffolder's standards.

Features

Create Project

Create a new local Skaffolder project by clicking on Create projects. The button will only appear if the extension can't find an openapi.yaml file in the root of the current workspace.

Create project Gif

Generate code

Generate the source code of your project from the openapi.yaml file.

Generate code Gif

Export project

Export your local project to Skaffolder Platform. Before exporting your project you need to login with your Skaffolder account.

Export project Gif

Create model

Create a new model in the Skaffolder project by clicking on the symbol + of a database from the TreeView of your project:

Create model gif

Or by typing sk model in the Command Palette:

Create model gif

Create api

Create a new api int the Skaffolder project by clicking on the symbol + of a model from the TreeView of your project:

Create api gif

Or by typing sk api in the Command Palette:

Create api gif

Create page

Create a new page in the Skaffolder project by clicking on the symbol + on the PAGES panel of your project:

Create page gif

Or by typing sk page in the Command Palette:

Create page gif

Create CRUD

Create a CRUD interface for a model by clicking by Create CRUD of a the model editing panel:

Create crud gif

Open Files

Open files related to a model, api or a page by clicking on the icon next the edit icon or by Open related files in the component's editing panel:

Open files Gif

Editing components

Edit a component by clicking the edit icon and a new editing panel will open. When saving, any modification will be written in the openapi.yaml file.

Add attribute from panel gif

Or you can edit directly from the openapi.yaml file:

Edit attribute from file gif

Requirements

Optional free Skaffolder account: https://skaffolder.com/register

Extension Settings for on-premise

  • skaffolder.endpoint: configure link with on-premise Skaffolder platform
  • skaffolder.endpointDocs: configure link with on-premise Skaffolder platform for displaying documentation

More info on Skaffolder on-premise for enterprises here.

Get Skaffolder on-premise from:

Contributing

Skaffolder-generator is an open-source project. Feel free to propose enhancements suggestions, report bugs and to submit pull requests.