Skip to content

Update README #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HeyItsBATMAN merged 1 commit into from
Jun 11, 2026
Merged

Update README #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,47 @@

Web Based 3D Viewer and 3D Annotation System.

## Requirements

- **[Bun](https://bun.sh/)** - runtime and package manager. `npm` / `yarn` / `pnpm` are **not** supported.

## Development setup

In order to setup your own development environment, you have to have [NodeJS](https://nodejs.org/en/) as well as Node Package Manager ([NPM](https://www.npmjs.com/)) installed.
Clone the repository, then install the dependencies with Bun:

```bash
git clone https://github.com/Kompakkt/Viewer
cd Viewer
bun install
```

Shared code from upstream Kompakkt packages (`@kompakkt/common`, `@kompakkt/komponents`, `@kompakkt/plugins`, `@kompakkt/server-openapi`) is pulled in automatically as git-pinned npm dependencies.

Clone this repository, cd to the project directory and run the following commands:
Start the Angular dev server:

```bash
bun start
```
$ git clone https://github.com/Kompakkt/Common.git src/common
$ npm i
$ ng serve

Navigate to `http://localhost:4200/viewer/`. The app will automatically reload if you change any of the source files.

### Selecting a backend

By default the viewer talks to the public Kompakkt server at `https://kompakkt.de/server/`. To point the viewer at a different backend (e.g. a locally running Kompakkt server), edit `src/environment.ts`:

```ts
export const environment = {
server_url: 'https://kompakkt.de/server/',
repo_url: 'https://kompakkt.de/',
};
```

Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
Adjust `server_url` to the URL of the Kompakkt server you want the viewer to talk to, and `repo_url` to the corresponding Kompakkt.Repo instance.

## Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
Run `bun run build` to build the project. The build artifacts will be stored in the `dist/viewer/` directory.

## Running the full stack

This repository only contains the Viewer frontend. To run Viewer, Repo and Server together (with all required supporting services such as Redis, Sonic and MongoDB), use the [Kompakkt/Mono](https://github.com/Kompakkt/Mono) environment.
Loading