Appwrite extension for Visual Studio Code
Go to file
2021-04-22 01:19:22 -07:00
.vscode initial commit 2021-04-19 13:11:56 -07:00
media/features edit permissions 2021-04-22 01:19:22 -07:00
resources initial commit 2021-04-19 13:11:56 -07:00
src edit permissions 2021-04-22 01:19:22 -07:00
.eslintrc.json initial commit 2021-04-19 13:11:56 -07:00
.gitignore initial commit 2021-04-19 13:11:56 -07:00
.prettierrc initial commit 2021-04-19 13:11:56 -07:00
.vscodeignore initial commit 2021-04-19 13:11:56 -07:00
CHANGELOG.md initial commit 2021-04-19 13:11:56 -07:00
LICENSE.md Add MIT license 2021-04-19 13:15:53 -07:00
package-lock.json health 2021-04-22 00:23:32 -07:00
package.json edit permissions 2021-04-22 01:19:22 -07:00
README.md edit permissions 2021-04-22 01:19:22 -07:00
tsconfig.json initial commit 2021-04-19 13:11:56 -07:00
vsc-extension-quickstart.md initial commit 2021-04-19 13:11:56 -07:00
webpack.config.js initial commit 2021-04-19 13:11:56 -07:00

Appwrite for Visual Studio Code

Use the Appwrite extension to quickly monitor, manage, and interact with your Appwrite instance directly from VS Code.

What is Appwrite?

From appwrite.io

Secure Open-Source Backend Server for Web, Mobile & Flutter Developers

Appwrite is a self-hosted solution that provides developers with a set of easy-to-use and integrate REST APIs to manage their core backend needs.

Features

View database documents right inside VS Code.

Database feature

Manage database collection permissions and rules.

Database feature

Create and view users, user preferences, and more.

Users feature

Quickly and easily check the health of all the Appwrite services.

Health feature

Requirements

This extension does not provide features for setting up or installing Appwrite. Only managing and interacting with Appwrite once it's running.

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

  • appwrite.projects: List of Appwrite project configurations. To set up a project configuration, run the Connect to Appwrite command. Search commands by hitting F1, then search Connect to Appwrite.

After connecting to an Appwrite project, your appwrite.projects setting will contain:

{
            "endpoint": "https://[Domain]/v1",
            "projectId": "[Project ID]",
            "secret": "API key with all scopes",
            "nickname": "My project"
}

We plan on adding better multi-project support in the future.

Known Issues

If you find issues, or want to suggest features, please file them in the issues section of the repository.

1.0.0

Initial release of the Appwrite extension for VS Code.

The initial release only includes features for Database, Users, and Health Appwrite APIs. However support for Storage and Functions APIs is on the way.


Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

Working with Markdown

Note: You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

  • Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux)
  • Toggle preview (Shift+CMD+V on macOS or Shift+Ctrl+V on Windows and Linux)
  • Press Ctrl+Space (Windows, Linux) or Cmd+Space (macOS) to see a list of Markdown snippets

For more information

Enjoy!