+

Sidekick Quickstart

Simple project to show how you can start using Sidekick Open Source in minutes
Explore Sidekick » Related Article »

About Sidekick

Sidekick is a live application debugger that lets you troubleshoot your applications while they keep on running.

Add dynamic logs and put non-breaking breakpoints in your running application without the need of stopping & redeploying.

Sidekick Open Source is here to allow self-hosting and make live debugging more accessible. Built for everyone who needs extra information from their running applications.

Check out Sidekick here

About the project

This project aims to show how you can start live debugging using a self-hosted Sidekick instance.

(back to top)

Built With

Express.js Socket.io

(back to top)

Getting Started

This is an end-to-end guide to show you how you can start using Sidekick Open Source.

Prerequisites

• Docker

  Make sure docker daemon is running.

• npm

  npm install npm@latest -g

• Visual Studio Code (Note: Sidekick has many other clients. Check out our headless options if you don't want to install a new IDE : https://docs.runsidekick.com/headless/ )

Installation

Running Sidekick with default settings

1. Clone the Sidekick repo

   git clone https://github.com/runsidekick/sidekick.git

2. Go to the docker folder under the project
3. Run command docker-compose up -d and wait for a minute
   • App is ready

Running Quickstart Project

1. Clone the Quickstar application repo

   git clone https://github.com/boroskoyo/sidekick-nodejs-quickstart.git

2. Install NPM packages

   npm install

3. Run!

   npm start

Now you have your self-hosted Sidekick instance and Quickstart application up and running.

It is time to use a client to put tracepoints and collect data from Quickstart application.

Starting to debug

1. Install Sidekick Extension form the VSCode marketplace:

2. Open the folder of Quickstart application (this repo)

3. .vscode folder in this repo should set the config for you. If you have any issues just check the instructions here: https://docs.runsidekick.com/plugins/visual-studio-code-extension-python-and-node.js/self-hosted-settings

4. Right click on 10th line on app/routes/index.js and put your first tracepoint. Check docs for extra info: https://docs.runsidekick.com/plugins/visual-studio-code-extension-python-and-node.js/tracepoints-and-logpoints

5. Visit http://localhost:3000 and use Quickstart application.

6. Observe your collected trace events at VSCode Sidekick: Trace Events panel!

Check out docs for more: https://docs.runsidekick.com/

(back to top)

Usage

Use this repo to discover how you can benefit from Sidekick Open Source.

For more examples, please refer to the Documentation

(back to top)

Contact

Barış Kaya - @boroskoyo - baris@thundra.io

Sidekick Repo: https://github.com/runsidekick/sidekick

(back to top)