An open API service indexing awesome lists of open source software.

https://github.com/brightics/studio

Component based analytics studio on the web browser
https://github.com/brightics/studio

ai low-code no-code no-code-ai

Last synced: 12 months ago
JSON representation

Component based analytics studio on the web browser

Awesome Lists containing this project

README

          

# Brightics Studio v1.3

[![Version](https://img.shields.io/github/v/release/brightics/studio)](https://github.com/brightics/studio/releases)
[![Release Date](https://img.shields.io/github/release-date/brightics/studio)](https://github.com/brightics/studio/releases)
[![Build Status](https://travis-ci.com/brightics/studio.svg?branch=master)](https://travis-ci.com/brightics/studio)
![CodeQL](https://github.com/brightics/studio/workflows/CodeQL/badge.svg)
![Download Counts](https://img.shields.io/github/downloads/brightics/studio/total.svg)
![Latest Counts](https://img.shields.io/github/downloads/brightics/studio/latest/total)
[![docker star](https://img.shields.io/docker/stars/brightics/studio)](https://hub.docker.com/r/brightics/studio)

[![community](https://img.shields.io/badge/Help-Community-brightgreen)](https://www.brightics.ai/community/categories)
[![youtube](https://img.shields.io/youtube/views/DR13sLVWXYs?style=social)](https://www.youtube.com/brighticsTV)

Brightics Studio

[[English](README_en.md)]
[[ํ•œ๊ตญ์–ด](README.md)]

MacOS / Linux ์‚ฌ์šฉ์ž๋Š” ๋ณธ ๋ฌธ์„œ ํ•˜๋‹จ์˜ ์„ค์น˜ ๊ฐ€์ด๋“œ๋ฅผ ๋”ฐ๋ผ ์ง„ํ–‰ํ•˜์‹œ๋ฉด Brightics Studio๋ฅผ ์‚ฌ์šฉํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

## Overview

---

- Brightics Studio๋Š” ๋ฐ์ดํ„ฐ ๊ณผํ•™์ž๋ฅผ ์œ„ํ•œ ์›น ๊ธฐ๋ฐ˜ ๋ฐ์ดํ„ฐ ๋ถ„์„ ์›Œํฌํ”Œ๋กœ์šฐ ๋„๊ตฌ์ž…๋‹ˆ๋‹ค.
- Brightics Studio๋Š” ์ง๊ด€์ ์ธ ์‚ฌ์šฉ์ž ์ธํ„ฐํŽ˜์ด์Šค๋ฅผ ์ œ๊ณตํ•˜๋ฉฐ ๋Œ€ํ™”ํ˜• GUI๋ฅผ ํ†ตํ•ด ๋ฐ์ดํ„ฐ์—์„œ ์ž ์žฌ์ ์ธ ํ†ต์ฐฐ๋ ฅ์„ ์ฐพ์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
- Brightics Studio๋Š” scikit-learn ๋ฐ pandas์™€ ๊ฐ™์€ ์ธ๊ธฐ ์žˆ๋Š” ํŒŒ์ด์ฌ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ํฌํ•จํ•˜์—ฌ ๋ถ„์„์„ ์œ„ํ•œ ์ธํ„ฐํŽ˜์ด์Šค๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.
- Brightics Studio๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์‹œํ‹ฐ์ฆŒ ๋ฐ์ดํ„ฐ ๊ณผํ•™์ž์™€ ์ „๋ฌธ ๋ฐ์ดํ„ฐ ๊ณผํ•™์ž ๋ชจ๋‘ ๋ฐ์ดํ„ฐ ๋ถ„์„ ํ”„๋กœ์ ํŠธ๋ฅผ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
- Brightics Toolkit์„ ํ†ตํ•ด ์ƒ์„ฑํ•œ ์‚ฌ์šฉ์ž ์ •์˜ ํ•จ์ˆ˜๋ฅผ Brightics ์›Œํฌํ”Œ๋กœ์—์„œ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
- ๋‹ค์–‘ํ•œ ๋ฐฉ๋ฒ•์œผ๋กœ ๋ฐ์ดํ„ฐ๋ฅผ ์‹œ๊ฐํ™”ํ•  ์ˆ˜ ์žˆ๋„๋ก ์ฐจํŠธ ๋ฐ ๋ณด๊ณ ์„œ ์ƒ์„ฑ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

## Documentation

---

[Brightics ํ™ˆํŽ˜์ด์ง€](https://www.brightics.ai)์—์„œ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

## Getting started

---

๋ฆด๋ฆฌ์ฆˆ ํŒŒ์ผ ํ˜น์€ docker ์ด๋ฏธ์ง€๋ฅผ ์ด์šฉํ•˜์—ฌ Brightics Studio๋ฅผ ์„ค์น˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

### Prerequisite
#
* ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค์™€ ์ƒํ˜ธ ์ž‘์šฉํ•˜๋Š” ์ผ๋ถ€ ๊ธฐ๋Šฅ์—๋Š” [Oracle Instant Client](http://www.oracle.com/technetwork/database/database-technologies/instant-client/overview/index.html) ์™€ ๊ฐ™์€ ํด๋ผ์ด์–ธํŠธ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๊ฐ€ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.
* [Installation - docker](#installation---docker)๋ฅผ ์ฐธ๊ณ ํ•˜์—ฌ Brightics Studio Docker ์ด๋ฏธ์ง€๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

### Installation - release file
#
* Download

๋ฆด๋ฆฌ์Šค ํŒŒ์ผ์€ github ๋ฆด๋ฆฌ์Šค ๋˜๋Š” [๋‹ค์šด๋กœ๋“œ ํŽ˜์ด์ง€](https://www.brightics.ai/downloads) ์—์„œ ๋‹ค์šด๋กœ๋“œ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋‹ค์šด๋กœ๋“œํ•œ ํŒŒ์ผ์„ ์‹คํ–‰ํ•˜๋ฉด ํŒŒ์ผ์ด ์ž๋™์œผ๋กœ ์ถ”์ถœ๋ฉ๋‹ˆ๋‹ค.

```
BrighticsStudio-\-\.exe : for windows
BrighticsStudio-\-\.sh : for linux (Ubuntu)
```

๋””๋ ‰ํ† ๋ฆฌ์˜ ์„ธ๋ถ€ ์‚ฌํ•ญ์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค:

```
/brightics-studio/brightics-server : core home
/brightics-studio/visual-analytics : GUI home
/brightics-studio/lib : external libs
```

* Launch

์‹คํ–‰ํ•˜๊ธฐ ์ „์— ์•„๋ฌด๊ฒƒ๋„ ์ค€๋น„ํ•  ํ•„์š”๊ฐ€ ์—†์Šต๋‹ˆ๋‹ค. ๋ฆด๋ฆฌ์Šค์—๋Š” ํŒจํ‚ค์ง€ ์ž์ฒด์˜ ๋ชจ๋“  ์š”๊ตฌ ์‚ฌํ•ญ์ด ํฌํ•จ๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.
์••์ถ•์„ ํ‘ผ ๋””๋ ‰ํ† ๋ฆฌ๋กœ ์ด๋™ํ•˜์—ฌ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.

```
Brightics-Studio-Launcher.exe : Launcher for windows
start-brightics.cmd : for windows
start-brightics.sh : for linux (Ubuntu)
```

> **Notes**
>
> ์„ค์น˜ ๊ฒฝ๋กœ์— ํ•œ๊ธ€์ด ํฌํ•จ๋œ ๊ฒฝ์šฐ Tokenizer(ํ•œ๊ตญ์–ด) ๊ธฐ๋Šฅ์ด ์ œ๋Œ€๋กœ ์ž‘๋™ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.
> ์ด ๊ธฐ๋Šฅ์„ ์‚ฌ์šฉํ•˜๊ธฐ ์œ„ํ•ด์„œ๋Š” ์ „์ฒด ๊ฒฝ๋กœ์— ํ•œ๊ธ€์ด ํฌํ•จ๋˜์ง€ ์•Š์€ ํด๋”์— Brightics Studio๋ฅผ ์„ค์น˜ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

* Patch

์ƒˆ ๋ฒ„์ „์ด ์ถœ์‹œ๋˜๋ฉด ์•„๋ž˜ ํŒŒ์ผ์„ ์ตœ์‹  ๋ฒ„์ „์˜ brightics-studio๋กœ ์ด๋™ํ•˜์—ฌ ๋ฐ์ดํ„ฐ์™€ ํ”„๋กœ์ ํŠธ๋ฅผ ์œ ์ง€ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

```
/brightics-studio/visual-analytics/brightics.db
/brightics-studio/brightics-server/data/*
```

* Run

Brightics Studio๋Š” start-brightics.cmd(๋˜๋Š” start-brightics.sh) ์‹คํ–‰ ํ›„ Chrome ๋ธŒ๋ผ์šฐ์ €์— ํŒ์—…๋ฉ๋‹ˆ๋‹ค.
Brightics Studio๊ฐ€ ์ž๋™์œผ๋กœ ํŒ์—…๋˜์ง€ ์•Š๋Š” ๊ฒฝ์šฐ ์ˆ˜๋™์œผ๋กœ http://127.0.0.1:3000 ์œผ๋กœ ์ด๋™ํ•˜์—ฌ Brightics Studio๋ฅผ ์‚ฌ์šฉํ•˜์‹ญ์‹œ์˜ค.

### Installation - docker
#
* Docker

์ž‘์—…ํ™˜๊ฒฝ์— [Docker](https://www.docker.com/get-started/)๋ฅผ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค.

* Docker Image

Brightics Studio Docker ์ด๋ฏธ์ง€๋Š” [Docker Hub](https://hub.docker.com/r/brightics/studio) ์—์„œ ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค.

์‹คํ–‰
```
$ docker volume create brightics
$ docker run -d -p 3000:3000 --privileged=true -v brightics:/brightics-studio/userdata --name brightics brightics/studio:latest
```

์ค‘์ง€
```
$ docker stop brightics
```

## Security warning
---
Brightics Studio ๋ฅผ ์‹คํ–‰ํ•˜๋ฉด ์„œ๋น„์ŠคํฌํŠธ(3000)๋กœ ์›น ์„œ๋น„์Šค๊ฐ€ ์‹คํ–‰๋˜๋ฏ€๋กœ ๋ณ„๋„ ๋ฐฉํ™”๋ฒฝ ๋˜๋Š” ์ ‘๊ทผ์ œ์–ด ์—†์ด ์ธํ„ฐ๋„ท์— ์˜คํ”ˆํ•˜๋Š” ๊ฒฝ์šฐ ์™ธ๋ถ€์—์„œ ์ ‘์†ํ•˜์—ฌ ๋ฐ์ดํ„ฐ ์œ ์ถœ ๋˜๋Š” ํ•ดํ‚น ์‹œ๋„ ๋“ฑ์ด ๋ฐœ์ƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ธํ„ฐ๋„ท์„ ํ†ตํ•œ ์ ‘๊ทผ์ด ๊ฐ€๋Šฅํ•œ ํ™˜๊ฒฝ์ธ ๊ฒฝ์šฐ ๋ฐฉํ™”๋ฒฝ์„ ํ†ตํ•ด ์ธ๊ฐ€๋œ PC์—์„œ๋งŒ ์‚ฌ์šฉํ•˜๋„๋ก ํ†ต์ œํ•˜์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค.

## Contact us
---
Brightics Studio๊ฐ€ ๋งˆ์Œ์— ๋“œ์…จ๋‹ค๋ฉด ์‚ฌ์šฉ ํ›„๊ธฐ์™€ ํ”ผ๋“œ๋ฐฑ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค.
๋˜๋Š” Brightics Studio ์‚ฌ์šฉ ์ค‘ ๊ถ๊ธˆํ•œ ์‚ฌํ•ญ์ด ์žˆ์œผ์‹œ๋ฉด ์ฃผ์ €ํ•˜์ง€ ๋งˆ์‹œ๊ณ  brightics.cs@samsung.com์œผ๋กœ ์—ฐ๋ฝ์ฃผ์„ธ์š”.

## License
---

Visual Analytics(Web GUI) project is licensed under the terms of the Brightics Visual Analytics LICENSE, please check Notice below.
The others are licensed under the terms of the Apache 2.0 license.

### Notice
#
Source codes of the Web GUI are not yet fully opened due to some license issues from its submodules.
The purpose of personal use for commercial or non-commercial is allowed but only the redistribution is prohibited.
See [the documentation about this license](BRIGHTICS_VA_LICENSE) for more details.
We are working hard to solve these issues and soon it will be public.

### Contributors
#
This project exists thanks to all the people who contribute.