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

Editing Project Definitions:

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

Viewing Documentation:

You can view documentation for project definitions by clicking on "Documentation" button at bottom of definition sidebar in neurelo panel. Clicking "documentation" button will open documentation in a panel.

Validating Schema:

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

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

Creating Custom Queries, Migrations, and Access Policies:

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

Deleting Custom Queries, Migrations, and Access Policies:

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

Open in neurelo:

You can open project in neurelo dashboard by clicking on an external link icon button beside selected project, selected branch or selected commit. You can also open schema, access-policies, custom-queries, migrations and custom-queries in neurelo dashboard by clicking on an 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 original schema, you can click on "Reset" button (Backspace Icon) at top of neurelo panel.

Features

 ▷ Access and view your projects using 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.
 ▷ Ability to create new Environments and Api Keys.
 ▷ Environment settings, Interact with Api Keys, Manage migrations, Documentation panel and start/stop runner feature for Environment.

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!