README.md

StackSpot IntelliJ Plugin

Table of contents

1. About

2. Getting Started

2.1. Build Requirements

2.2. Gradle Commands

3. Installation

4. Usage

5. Documentation

6. Contributing

7. Code of Conduct

8. License

9. Other Information

9.1. IntelliJ Plugin SDK documentation

About

StackSpot IntelliJ Plugin extends STK CLI to IntelliJ and allows you to create a StackSpot project, apply plugins, and many more features.

Getting started

Build Requirements

• IntelliJ IDEA 2022.1
• JDK 11

Gradle Commands

You need to use ./gradlew clean to make sure the changes you made are in the last binary. Now, follow:

1. Build a plugin to install in your IDE, run:

./gradlew clean buildPlugin

The zip file will be in build/distributions/{plugin_name}-{version}.zip

2. Run your code:

./gradlew clean runIde

Installation

This plugin is available on JetBrains Marketplace, but you can also install it through the zip file, see below:

• Install IntelliJ plugin from the disk

Usage

Create a new project (Project Wizard):

Using StackSpot tool window after the project opened:

Documentation

See StackSpot's documentation to learn more about IntelliJ's plugin:

• IntelliJ

Contributing

Check out our Contributing Guide to learn about our development process, how to suggest bug fixes and improvements.

See other guides:

• Security

• Developer Guide

Code of Conduct

Please follow the Code of Conduct in all your interactions with our project.

License

Apache License 2.0.

Other information

• IntelliJ Plugin SDK documentation