Sourcetrail

(โ˜… 16,489)

Sourcetrail - free and open-source interactive source explorer

File Explorer

Download Latest Version (.zip)
  • .clang-format
  • .gitignore
  • .travis.yml
  • appveyor.yml
  • AUTHORS.txt
  • CHANGELOG.md
  • CMakeLists.txt
  • CONTRIBUTING.md
  • DOCUMENTATION.md
  • LICENSE.txt
  • README.md
  • SPONSORS.md

# Installation Guide

1. Get the code
git clone https://github.com/CoatiSoftware/Sourcetrail

Downloads the entire project code from GitHub to your computer.

cd Sourcetrail

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f deployment/dockerfiles/linux/centos7_64/Dockerfile -t sourcetrail .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 sourcetrail

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ ์ปดํŒŒ์ผ๋Ÿฌ Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
$ cmake -G "Visual Studio 15 2017 Win64" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..

Type this command into your terminal and run it.

$ cmake -DCMAKE_BUILD_TYPE="Release" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..

Type this command into your terminal and run it.

-DClang_DIR=<path/to/llvm_build>/lib/cmake/clang

Type this command into your terminal and run it.

* __Download__: https://cmake.org/download

Type this command into your terminal and run it.

* __Remarks__: Make sure `git` is added to your `PATH` environment variable before running CMake

Type this command into your terminal and run it.

โœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

4. .NET

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd deployment/windows/wixSetup/CustomActions

This project's files live in a subfolder, so move into it first.

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

โœ… After dotnet run, check the message or address shown in the terminal.

5. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
cd java_indexer

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

โœ… A BUILD SUCCESS message means it worked. The output is created under target/.

6. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd testing/project_setup/java_gradle/data

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

โœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Today's picks

free-programming-books-zh_CN โ˜… 118,364

:books: ๅ…่ดน็š„่ฎก็ฎ—ๆœบ็ผ–็จ‹็ฑปไธญๆ–‡ไนฆ็ฑ๏ผŒๆฌข่ฟŽๆŠ•็จฟ
ai-agents-for-beginners โ˜… 72,946

18 Lessons to Get Started Building AI Agents

Jupyter Notebook
awesome-design-md โ˜… 109,537

A collection of DESIGN.md files analysis by popular brand design systems. Drop one into yo
ECC โ˜… 241,634

The agent harness performance optimization system. Skills, instincts, memory, security, an

JavaScript
Python-100-Days โ˜… 185,241

Python - 100ๅคฉไปŽๆ–ฐๆ‰‹ๅˆฐๅคงๅธˆ

Jupyter Notebook
llama.cpp โ˜… 124,999

LLM inference in C/C++

C++
// repository documentation