Skip to content

example.md

Latest commit

 

History

History
71 lines (51 loc) · 4.21 KB

example.md

File metadata and controls

71 lines (51 loc) · 4.21 KB

Configuring your device 🧑‍💻

👉 In this section, we aim to provide you with all the resources to configure your developer environment to start building on alis.exchange.

If you face any difficulties in the process, check out the community Q&A and feel free to ask if your issue has not been dealt with yet.

Command-line Interface

The alis CLI was adopted as a core tool to manage all alis.exchange resources, which will be unpacked in the following onboarding section 🤓. All you need to do at this stage is to install the CLI by following the process described in the CLI repo.

Jetbrains GoLand

The GoLand integrated development environment (IDE) is the best supported IDE within the alis.exchange community and various plugins have been adopted and built to aid the developer experience on alis.exchange.

  1. Follow the relevant installation instructions for your device. NOTE: Start off using the trial version. Notify your organisation to purchase a license for your account if this was not yet provided.
  2. In the IDE, open the Preferences... and navigate to Plugins. In the marketplace, search for and install the latest versions of the following plugins:
    • EnvFile - Borys Pierov
    • .env files support - Adel F
    • GitToolBox - Lukasz Zielinski
    • Terraform and HCL - Jetbrains
    • AIP Linter - alis_ - AI Driven Investments

Plugin Configuration

AIP Linter Plugin

The AIP linter plugin requires the installation of the executable file built by Google. This can be done by running:

go install github.com/googleapis/api-linter/cmd/api-linter@latest

Once this is installed, you will need to point the plugin to this downloaded api-linter.exe file. In Preferences/Tools/AIP Linter set the api_linter_executable to the downloaded executable. This should be in the /Users/{{YourUsername}}/go/bin directory.

The Import Paths are used to find imported *.proto files. At this stage, we will simply add the Google protos.
❗ Ensure that you have run the command alis org get google from your terminal to get the relevant protos downloaded locally.

Unselect the option to Configure automatically and add the path to the Google proto directory, /Users/{YourUsername}/alis.build/google/proto, to the Import Paths.

Your final configuration should look similar to the image below.

Once you start coding, you will need to add all of the proto Import Paths that are being used by the protos you are working on. Using the example of an organisation foo, the import path would be /Users/{YourUsername}/alis.build/foo/proto

Protocol Buffers Plugin

Similar to the AIP Linter Plugin, the Protocol Buffers Plugin requires a specification of the directories where imported protos can be found. At this stage, we will simply add the Google protos.

Add the path to the Google proto directory, /Users/{YourUsername}/alis.build/google/proto, to the Import Paths.

Your final configuration should look similar to the image below.

Once you start coding, you will need to add all of the proto Import Paths that are being used by the protos you are working on. Using the example of an organisation foo, the import path would be /Users/{YourUsername}/alis.build/foo/proto

End 🏁

You are all set up and ready to start building. But before we get there, we need to first establish the most essential concepts on alis.exchange

👟 Up next: alis.exchange core concepts 🚀

Already have an understanding of the concepts?

Build your first product 👷‍