https://github.com/cayleygraph/web

Web interface for Cayley
https://github.com/cayleygraph/web

cayley material-components react typescript

Last synced: about 2 months ago
JSON representation

Web interface for Cayley

• Host: GitHub
• URL: https://github.com/cayleygraph/web
• Owner: cayleygraph
• Created: 2019-09-12T12:13:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-03T10:29:52.000Z (over 1 year ago)
• Last Synced: 2024-08-01T13:39:00.734Z (5 months ago)
• Topics: cayley, material-components, react, typescript
• Language: TypeScript
• Homepage: https://cayley-ui.netlify.com
• Size: 5.54 MB
• Stars: 25
• Watchers: 4
• Forks: 5
• Open Issues: 26
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cayley Web

[![Docker build status](https://img.shields.io/docker/cloud/build/cayleygraph/web)](https://hub.docker.com/repository/docker/cayleygraph/web/)

[![TravisCI build status](https://travis-ci.com/cayleygraph/web.svg?branch=master)](https://travis-ci.com/cayleygraph/web)

Web interface for [Cayley](https://cayley.io)

![Demo Screenshot](docs/demo.png)

## Table of Contents

- [Run](#Run)

- [Features](#Run)

- [Technologies Used](#technologies-used)

- [Develop](#Develop)

## Run

### Run with Docker

```bash

docker run -p 3000:80 cayleygraph/web

```

#### Modify Server URL

By default, the server URL is set to http://localhost:64210 (the default Cayley server URL). To change it pass `SERVER_URL` environment variable.

For example:

```

docker run -p 3000:80 --env SERVER_URL="http://example.org:64210" cayleygraph/web

```

## Features

- Query Editor

- Data Editor

- Data Browser

### Technologies Used

- [React](https://reactjs.org) ([CRA](https://create-react-app.dev/))

- [TypeScript](https://www.typescriptlang.org/)

- [Monaco Editor](https://microsoft.github.io/monaco-editor/)

- [RMWC](https://rmwc.io/)

- [React Select](https://react-select.com/)

- [Yarn](https://yarnpkg.com/)

## Develop

1. Make sure to have [Node.js](https://nodejs.org/en/download/), [Yarn](https://classic.yarnpkg.com/en/docs/install) and a modern web browser

2. Clone the repository

3. Get into the cloned directory

4. Install dependencies

   ```bash

   yarn

   ```

5. Run Cayley HTTP Server

   ```bash

   cayley http

   ```

6. Start the development server

   ```

   yarn start

   ```

7. Run tests

   ```

   yarn test

   ```