Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
60 changes: 36 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,45 @@

**Configurable Web Application to analyse TE results.**

Full documentation for the project is available at <>.
## Examples

# Overview
# Requirements
Demo is available [here](https://ts-factory.io/bublik/).

- **Debian 12 or 13, or Ubuntu 22.04 or 24.04**
- **Python 3.10 or 3.11 or 3.12 or 3.13**
## Documentation

# Installation
1. Clone [bublik backend](https://github.com/ts-factory/bublik.git) to /opt/bublik/**bublik**.
2. Clone [bublik frontend](https://github.com/ts-factory/bublik-ui.git) to /opt/bublik/**bublik-ui**.
3. Clone [site-specific configuration](https://github.com/ts-factory/ts-rigs-sample.git) to /opt/bublik/**ts-rigs**.
4. Launch deploy script:
Full documentation is available [here](https://ts-factory.github.io/bublik-release/).

## Requirements

- Debian 12 or 13, or Ubuntu 22.04 or 24.04
- Python 3.10 or 3.11 or 3.12 or 3.13

## Installation
1. Clone [Bublik backend](https://github.com/ts-factory/bublik.git):

```
git clone https://github.com/ts-factory/bublik.git
```

2. Launch the initial deployment script, specifying the host:

```
./scripts/init_deploy.sh <host name>
```

You can also use the initial deployment and deployment options to provide additional parameters.
To see all available options, run:

```
cd /opt/bublik/bublik
./scripts/deploy -c ol/selftest -H bublik-db -k /etc/bublik.keytab
./scripts/init_deploy.sh -h
./scripts/deploy -h
```
5. Check to NGINX settings in /etc/nginx/sites-available/bublik:

> **Important:** Make sure you have root (or `sudo`) access to the target host
> before running the initial deployment script.

3. Check to NGINX settings in /etc/nginx/sites-available/bublik:

```
location /v2/ {
alias /opt/bublik/bublik-ui/dist/bublik/;
Expand All @@ -32,17 +52,9 @@ Full documentation for the project is available at <>.
}
```

# Examples

Demo is available at https://ts-factory.io/bublik/

# Documentation

For now some documentation can be found in **doc/wiki** here.

# Development
## Development

## Pre-commit checkings
### Pre-commit checkings

After initial deploy please run the:
```
Expand All @@ -56,7 +68,7 @@ Please note that you can always disable the pre-commit validation by running:
pre-commit uninstall
```

## Checking your changes
### Checking your changes

You can use pyformat script to check your changes.

Expand Down
File renamed without changes.