Neurelo's VS Code Extension

Work with your projects directly from your IDE using Neurelo's VS Code extension.

---

How to use

Start using Neurelo's VS Code Extension:

To start using the extension, you need to have a Neurelo account. If you don't have one, you can sign up for free here. After installing the extension, you can click on the Neurelo icon in the sidebar to log in and start using the extension. After login users will be prompted to select organization, project, branch and commit ID to start working on the project.

Editing Project Definitions:

Once you have selected the project, you can view the project definitions the neurelo panel. You can view the schema, custom-queries, migrations, and access-policies. You can edit these definitions and push the changes to Neurelo using the commit button at the top of the panel.

Viewing Documentation:

You can view the documentation for the project definitions by clicking on the documentation button at the bottom of definition sidebar in neurelo panel. Clicking the button will open the documentation in new document panel.

Validating Schema:

From neurelo panel, you can click on "Schema" from definition sidebar to open the schema associated with the commit and start editing. Now you can validate the schema by clicking on the validate button at the top of the schema sidebar.

Note: After editing any definition files, users must save the file before validating or pushing the changes. Unsaved files are not tracked.

Creating Custom Queries, Migrations, and Access Policies:

For creating a new item, click on the "+" button at the right side of sidebar title. This will open a dialog box when you can input the name of the new item and click on create button.

Deleting Custom Queries, Migrations, and Access Policies:

For deleting an item, click on the "trash" icon in the dropdown menu of the item. You can open the dropdown menu by clicking on the three dot button at the right side of the item.

Open in neurelo:

You can open the project in neurelo dashboard by clicking on the external link icon button beside the selected project, selected branch or selected commit. You can also open the schema, access-policies, custom-queries, migrations and custom-queries in neurelo dashboard by clicking on the external link icon button beside the item.

Reset schema:

While editing definitions in head commit, if you make any changes to definitions and want to revert back to the original schema, you can click on the reset button (Backspace Icon) at the top of the neurelo panel.

Features

 ▷ Access and view your projects using the sidebar view.
 ▷ Review any of the commits (current or previous) in your project definitions.
 ▷ Ability to add/modify/delete the schema, REST/GraphQL custom-queries, migrations or access-policies.
 ▷ Push changes to Neurelo.
 ▷ Validation of schema, custom-queries, and access-policies (including for remote repositories).
 ▷ Ability to view the documentation for project definitions.
 ▷ Ability to copy API/SDK code examples for your project.

Known Issues (Roadmap)

 ▷ Autocompletion support coming soon.
 ▷ Ability to create new projects and delete projects coming soon.
 ▷ Ability to perform actions on Environments and Data Sources coming soon.
 ▷ Note - You can always perform these actions and more using the Neurelo Dashboard web app.

For more information

• Neurelo VS Code Extension Documentation

💻   Happy Coding!