Trinity - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #golang #android #deep-learning #docker #java #windows #awesome #cli #awesome-list #open-source

Trinity

(★ 145)

A VSCode extension for Cypher and Neo4j

파일 탐색기

최종 버전 다운로드 (.zip)

- extensions.json
- launch.json
- settings.json
- tasks.json
- extension.js
- extension.js.map
- - bugReport.md
  - contributing.md
  - featureRequest.md
- - basicDemo.gif
- Trinity-Logo.png
- - boolean.svg
  - dependency.svg
  - document.svg
  - edit.svg
  - folder.svg
  - number.svg
  - refresh.svg
  - string.svg
- - boolean.svg
  - dependency.svg
  - document.svg
  - edit.svg
  - folder.svg
  - number.svg
  - refresh.svg
  - string.svg
- final.png
- - OutlineProvider.ts
  - parseExtract.ts
  - queryRunner.ts
  - readConfig.ts
- - runTest.ts
- extension.ts
.eslintrc.json
.gitignore
.trinity.json
.vscodeignore
CHANGELOG.md
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
vsc-extension-quickstart.md
webpack.config.js

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/oslabs-beta/Trinity

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd Trinity

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img width="250px" src="https://raw.githubusercontent.com/oslabs-beta/Trinity/dev/DOCUMENTATION/Trinity-Logo.png" />
</p>

# Trinity

## What is Trinity?

Trinity is a VS Code extension for previewing Neo4j queries and database structure within the VS Code environment. Trinity intends to remove the need for switching between VS Code and Neo4j Desktop or Neo4j Browser during the development process.

## Features

### **Core Features**

1. Connects to a user's Neo4j database and displays the graph database structure (Node Labels, Properties and Unidirectional/Bidirectional relationships).
2. Parses Neo4j/Cypher queries/mutations that are typed into the current open document in VS Code.
3. Sends the queries/mutations to a database as defined in the user's configuration file .
4. Renders the responses to the Trinity output channel on VS Code.
5. Optionally writes the output to a local JSON file based on the user's configuration.

<img width="800px" src="https://raw.githubusercontent.com/oslabs-beta/Trinity/dev/DOCUMENTATION/gifs/basicDemo.gif" alt="demo gif" />

## Getting Started

### **Installation**

Trinity can be installed from the VS Code Extensions marketplace [here](https://marketplace.visualstudio.com/items?itemName=Trinity.trinity).

### **Setting up the config file**

In your working directory create a
`.trinity.json` file. The following configuration options are available for setup by the user:

```json
{
  "dbAddress": "bolt://localhost",
  "username": "neo4j",
  "password": "test",
  "clearChannelOnSave": true,
  "writeOutputToJSON": true,
  "JSONOutputRelativePath": "./",
  "outputFilename": "output.json"
}
```

Required Settings: `dbAddess`, `username` and `password`.

Default settings when not defined in the configuration file:

```json
{
  "clearChannelOnSave": false,
  "writeOutputToJSON": false,
  "JSONOutputRelativePath": "./",
  "outputFilename": "output.json"
}
```

## Write and Invoking your first Trinity query

To activate the extension and connect to your Neo4j Database:

1. Search for Trinity from the command palette in VS Code (Cmd/Ctrl + Shift + P) and run the _`Trinity: Run Trinity`_ command.
2. To deactivate, search for Trinity from the command palette in VS Code (Cmd/Ctrl + Shift + P) and run the _`Trinity: Deactivate Trinity`_ command.

The following steps are required to setup a `Trinity` query inside your working file.

1. Create a function declaration for your `Trinity` query
2. Invoke your Cypher Query within a Trinity function invocation\*
3. On every save, Trinity will send any requests inside of the `Trinity` functions to your Neo4j Database and show responses in the Trinity Output Channel. To send another request, create a new invocation of the `Trinity` function and put the new request as the argument. Output will also be saved to a JSON file if setup in the configuration file.

_\*Multiple queries may be invoked within a single file. Current functionality does not support the passing of variables or parameterized queries._

---

### Sample Python Setup

```python
# Create a Trinity function definition in your working file.
def Trinity ():
  return

# Anywhere in your open file, put a Neo4j Cypher query inside the Trinity function. For example:
Trinity('Match (n{name: "Carrie-Anne Moss"}) Return n')
```

### Sample JavaScript Setup

```javascript
// Create a Trinity function definition in your working file.
function Trinity() {}

// Anywhere in your open file, put a Neo4j Cypher query inside the Trinity function. For example:
Trinity('Match (n{name: "Carrie-Anne Moss"}) Return n');
```

On every save, Trinity will send any requests inside of the `Trinity` functions to your Neo4j Database and show responses in the Trinity Output Channel. To send another request, create a new invocation of the `Trinity` function and put the new request as the argument.

---

## Contributing and Issues

We are always looking to improve. If there are any contributions, feature requests or issues/bugs you have, please check out our documentation on [contributions](./DOCUMENTATION/docs/contributing.md), [feature requests](./DOCUMENTATION/docs/featureRequest.md) or [issues/bugs](./DOCUMENTATION/docs/bugReport.md).

## Release Notes

Created by: Alex Bednarek, Alex Drew, Connor Bovino, Olena Danykh

0.0.1 | Initial release of Trinity, More to come!