Skip to content

Contributing Using VSCode

Getting Started

Install VSCode

https://code.visualstudio.com/download

Fork Project in Github

This is making a duplicate of the code under your Github that you can edit.

https://github.com/amidaware/tacticalrmm

ForkIt

Add your (forked) repo to VSCode

  1. Clone repository.

  2. Login to your Github.

  3. Choose local folder.

Install extra VSCode Extensions

  • GitLens

  • Remote - SSH

Open Terminal

https://code.visualstudio.com/docs/editor/integrated-terminal

Ctrl+`

Configure a remote for your fork (in VSCode)

https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork

Configure your local fork and tell it where the original code repo is so you can compare and merge updates later when official repo is updated.

Check repos:

git remote -v

Add upstream repo:

git remote add upstream https://github.com/amidaware/tacticalrmm

Confirm changes:

git remote -v

Contribute code

  1. Make changes to something.

  2. Commit (update something) and notate what you did.

  3. Push (from your local vscode to your github fork).

  4. Open your browser and look at your repo (It should reflect your commit).

Request your changes to be pulled into the primary repo (Pull Request)

Changes you've made need integration with master repo

In your browser, create a pull request.

Sync your local fork

https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork

Bring changes from original repo to your local vscode copy so you're current with changes made in original Github repo:

Sync Fork

In VSCode open TERMINAL:

Ctrl+`

Tell git to pull from the GitHub upstream repo all new changes into your local directory:

git pull --rebase upstream develop

Push your local updated copy to your Github fork

Then you're pushing that updated local repo to your online Github fork:

Sync push/pulls

Verify and Repeat

Check your Github fork in browser, it should be up to date now with original. Repeat 6 or 7 as necessary.


Reference

Customizing the Admin Web Interface

Created using Quasar, it's all your .vue files in web/src/components/modals/agents/RunScript.vue.

Learn stuff here:

https://quasar.dev/