https://github.com/vesoft-inc/nebula-studio
NebulaGraph Web GUI Tools
https://github.com/vesoft-inc/nebula-studio
hacktoberfest
Last synced: about 1 year ago
JSON representation
NebulaGraph Web GUI Tools
- Host: GitHub
- URL: https://github.com/vesoft-inc/nebula-studio
- Owner: vesoft-inc
- License: apache-2.0
- Created: 2021-08-20T09:46:38.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-07T03:53:49.000Z (about 1 year ago)
- Last Synced: 2025-05-07T04:32:49.578Z (about 1 year ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 61.7 MB
- Stars: 234
- Watchers: 27
- Forks: 69
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NebulaGraph Studio
NebulaGraph Studio (Studio for short) is a web-based visualization tool for NebulaGraph. With Studio, you can create a graph schema, import data and edit nGQL statements for data queries.
## Architecture
## Version
| NebulaGraph version | NebulaGraph Studio tag |
|----------------------|---------------------------|
| 1.x | v1.2.7 |
| 2.0.x | v2.2.x |
| 2.5.x | v3.0.x |
| 2.6.x | v3.1.x |
| 3.0.x | v3.2.x |
| 3.1.x | v3.3.x |
| 3.0.0 ～ 3.2.0 | v3.4.x |
| 3.0.0 ～ 3.3.0 | v3.5.x |
| 3.0.0 ～ 3.4.0 | v3.6.x |
| 3.0.0 ～ 3.5.0 | v3.7.x |
| 3.0.0 ～ 3.6.0 | v3.8.x |
| 3.0.0 ～ 3.6.0 | v3.9.x |
| 3.0.0 ～ 3.8.0 | v3.10.x |
## Development Quick Start
### set up studio and server at the same time
```
$ npm install
$ npm run dev
$ npm run dev:go
```
### Set up nebula-graph-studio only
```
$ npm install
$ npm run dev
```
### Set up go-server only
```
$ cd ./server/api/studio
$ make run
```
## Production Deploy
### 1. Build Web
```
$ npm install
$ npm run build
$ mv dist/* server/api/studio/assets
```
### 2. Build Server
```
$ cd server/api/studio
// update default port 9000 to 7001 in etc/studio-api.yaml first
$ go build -o server
```
### 3. Start
```
$ ./server &
```
### 4. Stop Server
Use when you want shutdown the web app
```
kill -9 $(lsof -t -i :7001)
```
## Documentation 3.10.0
[中文](https://docs.nebula-graph.com.cn/3.8.0/nebula-studio/about-studio/st-ug-what-is-graph-studio/)
[ENGLISH](https://docs.nebula-graph.io/3.8.0/nebula-studio/about-studio/st-ug-what-is-graph-studio/)
## Contributing
Contributions are warmly welcomed and greatly appreciated. Please see [Guide Docs](https://github.com/vesoft-inc/nebula-studio/blob/master/CONTRIBUTING.md)