Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevinmichaelchen/neo4j-go-file-system
Rudimentary object graph using Go and Neo4j
https://github.com/kevinmichaelchen/neo4j-go-file-system
docker go golang neo4j seabolt
Last synced: 25 days ago
JSON representation
Rudimentary object graph using Go and Neo4j
- Host: GitHub
- URL: https://github.com/kevinmichaelchen/neo4j-go-file-system
- Owner: kevinmichaelchen
- Created: 2019-01-16T21:48:26.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-25T20:06:31.000Z (about 6 years ago)
- Last Synced: 2025-01-10T20:01:02.687Z (29 days ago)
- Topics: docker, go, golang, neo4j, seabolt
- Language: Go
- Homepage:
- Size: 140 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# neo4j-go-file-system
A proof of concept demonstrating how to create
a small graph of objects (files, folders, users, organizations, and policies)
that when put together look something like a rudimentary file system.
[Neo4j](https://neo4j.com/) feels like a natural choice for database,
since our goal is to represent a file system tree and users' relationships to certain nodes in that tree.
In this model, organizations (red nodes) represent file system root.
The blue nodes are the users.
The yellow nodes are the folders.
The green nodes are the files.
## Getting started
This guide expects your Neo4j password to be in the `.env` file.
If you've never configured Neo4j, the default password should be `neo4j`.
Set that in your `.env` file:
```bash
$ cat .env
NEO_PASSWORD=neo4j
```
| Command | Description |
| -------------- |:------------------------------------------------:|
| `make` | Runs containers |
| `make rebuild` | Rebuilds images from scratch and runs containers |
| `make stop` | Stops running containers |
Once started, the Neo4j container will be accessible via http://localhost:7474.
Log in with the username `neo4j` and whatever password you've configured (`neo4j` is the default out-of-the-box password).
## REST API
### Creating a user
```bash
curl http://localhost:8080/user -H 'Origin: http://localhost:3000' -d '{"resourceID": 22, "emailAddress": "[email protected]", "fullName": "Kevin Chen22"}'
```
### Getting a file
```bash
curl http://localhost:8080/file/9c73cde3-d8f9-4048-bfd9-00e0484fdb89 -H 'Origin: http://localhost:3000'
```
### Moving a file
```bash
curl -X POST http://localhost:8080/move -H 'Origin: http://localhost:3000' -d '{"sourceID": "7a1ced19-5396-4c44-bc30-4953d59453d5", "destinationID": "0871b5af-4954-4d21-9e1f-3781e269374a", "newName": "cloud-auth-moved"}'
```
## gRPC API
We can test out our gRPC API on the command line with [grpcurl](https://github.com/fullstorydev/grpcurl).
It behaves like `curl`, but it can process binary payloads.
To install it, run
```bash
go get github.com/fullstorydev/grpcurl
go install github.com/fullstorydev/grpcurl/cmd/grpcurl
```
There are some calls you can make to see what kinds of methods your API supports:
```bash
grpcurl -import-path ./src/pb -proto file.proto list
grpcurl -v -plaintext localhost:50051 list pb.FileService
```
### Files
```bash
grpcurl -v -plaintext -d '{"userID": "4", "fileID": "7a1ced19-5396-4c44-bc30-4953d59453d5"}' localhost:50052 pb.FileService/GetFile
```
### Organizations
```bash
grpcurl -v -plaintext -d '{"organization": {"id": 1}}' localhost:50051 pb.OrganizationService/GetOrganization
grpcurl -v -plaintext -d '{"organization": {"id": 2, "name": "My Custom Org"}}' localhost:50051 pb.OrganizationService/CreateOrganization
```
## Reading
- [Docker Compose reference](https://docs.docker.com/compose/compose-file/)
- [Background on Seabolt driver](https://medium.com/neo4j/neo4j-go-driver-is-out-fbb4ba5b3a30)
- [Neo4j with Docker](https://neo4j.com/developer/docker/)
- [neo4j-go-driver](https://github.com/neo4j/neo4j-go-driver) repo
- [seabolt](https://github.com/neo4j-drivers/seabolt) repo
- [The Dark Side of Neo4j](https://neo4j.com/blog/dark-side-neo4j-worst-practices/)