Skip to content

Development

Manuel Gil @imgildev edited this page Feb 7, 2025 · 1 revision

This section guides you through setting up and contributing to the development of JSON Flow. Ensure you meet the prerequisites and follow the steps below.


Prerequisites

To get started, ensure you have the following installed on your machine:

  • Node.js (Download from the official website)
  • npm or yarn
  • Visual Studio Code
  • Git

Getting Started

Follow these steps to set up your development environment:

  1. Clone the Repository Clone the project repository from GitHub:

    git clone
  2. Install Dependencies Navigate to the project directory and install dependencies:

    npm install
  3. Open the Project in VS Code Open the project in Visual Studio Code:

    code .
  4. Run the Extension Press F5 to launch the Extension Development Host. A new instance of VS Code with the extension loaded will open.

  5. Modify Code Make your changes in the src/ directory.


React Webview Development

To test and develop the webview functionality:

  1. Run the development server:

    npm run dev
  2. This will open a new window with the extension loaded.

  3. Make your changes in the webview/ directory.


Build

Compile Webview

  1. Run the build command:

    npm run build
  2. Launch the Extension Development Host:

    Press F5

Resources

For questions or issues, refer to the documentation or reach out to contributors on GitHub.

Clone this wiki locally