developer.sailpoint.com

(β˜… 51)

The codebase that makes up developer.sailpoint.com, including developer documentation. This codebase is open source and welcomes contributions.

  • .firebaserc
  • .gitignore
  • .prettierignore
  • .prettierrc
  • .slinkignore
  • api-redirects-plugin.ts
  • api.mustache
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • createApiPageMD.ts
  • docusaurus.config.extensibility.ts
  • docusaurus.config.minified.ts
  • docusaurus.config.ts
  • firebase.json
  • footer.ts
  • LICENSE
  • navbar.ts
  • package-lock.json
  • package.json
  • plugins.ts
  • README.md
  • samconfig.toml
  • sidebars.extensibility.ts
  • sidebars.minified.ts
  • sidebars.ts
  • template.yaml
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/sailpoint-oss/developer.sailpoint.com

Downloads the entire project code from GitHub to your computer.

cd developer.sailpoint.com

Moves into the project folder you just downloaded.

2. Maven (Java)

Medium Recommended
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.
⚠️ 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 backend/src/java

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/.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install npm@latest -g

Downloads and installs the libraries listed in package.json.

npm install

Downloads and installs the libraries listed in package.json.

npm run gen-api-docs-all

Type this command into your terminal and run it.

npm run start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
⚠️ 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 backend/src/go

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

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
⚠️ 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 backend/src/go

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

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation