Skip to main content

Visual Studio Code Setup

This chapter covers opening the newly created or migrated project in VSCode, configuring the necessary settings, and building the user module.

Opening the Project in VSCode​

Open the project using one of the following methods:

  • From VSCode's menu: Launch VSCode → select File → Open Folder... from the menu → select the project root folder.

  • From the command line: Run the following command from the project root directory:

    code .

Installing Extensions​

Open the Extensions icon (the icon of overlapping squares) in VSCode's left sidebar and install the extensions you want to use. For more details, refer to the official documentation: https://code.visualstudio.com/docs/getstarted/extensions

Extensions for intra-mart Accel Platform development

Extensions are available that let you create and manage projects, deploy to a server, and debug and test server-side scripts from the VSCode UI. See Using Visual Studio Code for details.

Agent Setup​

If you are using an agent via the VSCode extension, sign in according to the agent you selected.

GitHub Copilot​

  1. Click the account icon in the lower-left of VSCode and sign in to VSCode with the GitHub account that has access to Copilot.

For detailed steps, refer to the official documentation: https://code.visualstudio.com/docs/copilot/setup

Claude Code​

  1. If the Claude Code extension is not installed, follow the instructions at https://code.claude.com/docs/en/vs-code to install it from VSCode Extensions.
  2. After installation, launch the extension and sign in with your Anthropic account.

For more details, refer to the official documentation: https://code.claude.com/docs/en/vs-code

OpenAI Codex​

  1. If the OpenAI Codex extension is not installed, follow the instructions at https://developers.openai.com/codex/quickstart?setup=ide to install it from VSCode Extensions.
  2. After installation, launch the extension and sign in with your ChatGPT account or API key.

For more details, refer to the official documentation: https://developers.openai.com/codex

Installing Dependencies and Building​

Open the integrated terminal in VSCode (from the menu: Terminal → New Terminal, or Ctrl + ` / Control + `) and run the following commands in order:

Installing dependencies​

bun install

This command fetches the dependencies listed in package.json. When complete, a node_modules/ directory is created.

Building the user module​

bun run build

This executes the build script in package.json (which internally calls Maven), generating the user module.

Verification: When the build completes successfully, BUILD SUCCESS appears near the final lines of output, along with the output path of the artifact.

About the generated user module

The imm file created by e Builder is a <artifact-name>-<version>.zip file generated under the target folder, renamed with a .imm extension. The <artifact-name>-<version>.zip generated under target can be used as a user module in the same way as an imm file.

Deploying the Artifact (Reference)​

The user module generated by the build is incorporated into a WAR file using IM-Juggling and deployed to iAP. For detailed steps, refer to the official documentation:

Using Docker for the iAP Development Environment

You can set up an iAP development and verification environment on your local PC using Docker. Docker eliminates the need to install middleware such as Resin, a database, or Solr individually, allowing you to build an iAP development environment quickly. It also provides high environment reproducibility, minimizing differences between team members' environments.

For setup instructions using Docker, refer to the intra-mart Accel Platform Development Environment Setup Guide (Docker Edition).

Deploying with the Accel CLI

You can deploy to the iAP development and verification environment with the Accel CLI. It supports hot deployment, so you can deploy a user module without building a WAR file.

You can deploy with the following commands.

# First time only: register the URL and API key of the development environment
bunx @intra-mart/accel login

# Deploy
bunx @intra-mart/accel deploy

For details, see Deploy (Asset Transfer).

VSCode Tips for Beginners​

FeatureDescriptionHow to open
Activity BarThe vertical icons on the far left. Switches between file explorer, search, source control, extensions, debug, and more.Always visible
Command PaletteThe entry point for running any feature by name.Ctrl + Shift + P (Windows/Linux), Shift + Command + P (macOS)
Integrated TerminalOpens a shell inside VSCode for running commands.Ctrl + ` (Windows/Linux), Control + ` (macOS)
ExplorerDisplays the project file tree.Top icon in the Activity Bar
If a problem occurs during VSCode setup

Refer to the "CLI Execution and Verification Issues" section of Troubleshooting.