From b0edaad1caa72a4832600d7e332755452fa55be1 Mon Sep 17 00:00:00 2001 From: Richard Dunks Date: Sat, 9 May 2020 13:09:50 -0500 Subject: [PATCH 1/4] fixing README.md link to Saga to close #4 --- readme.md | 77 +++++++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 39 deletions(-) diff --git a/readme.md b/readme.md index c70b7a4..06bba8f 100644 --- a/readme.md +++ b/readme.md @@ -1,39 +1,38 @@ -### Vega Install Guide - -The platform which Vega is built on is called lyra. To start, install the lyra command line interface: - -``` -npm install -g @lyra/cli -``` - -Before creating your project you must change two values in the `/usr/bin/lyra` file to make the install work. Search for “example-venue” and change the two references to “example-journal”. - -Then, run the setup wizard with: - -``` -lyra init -``` - -You will be prompted to set the following values: - -``` -Name of your project: yourproject -Backend API Host: http://yourIPorFQDN:4000 -Name of default venue (as configured in the backend): yourproject -Name of dataset for default venue: yourproject -``` - -`Output path: /root/yourproject` (you can choose to keep the default by hitting enter) - -`Select project template Example venue (with sample plugins)` - -When completed, you have a project folder with a new Vega instance. Change directories to that folder and run `lyra start`. Then open your browser and point it to the URL prompted to you in the terminal. - -You should see something like this once Lyra has started: - -``` -root@vega:/vega# lyra start -✔ Checking configuration files... -⠧ Compiling...webpack built baa56a497c2a472473fc in 17836ms -✔ Compiling... -Content Studio successfully compiled! Go to http://yourdomain.com:3333 \ No newline at end of file +# Vega + +[![Build Status](https://travis-ci.org/VegaPublish/vega.svg?branch=master)](https://travis-ci.org/VegaPublish/vega) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) + +# Getting started + +## Prerequisites + +* Node.js 8.x or later +* npm v6.0 or later +* A running instance of Saga + +## Saga, Lyra, Vega? + +**Saga** is the backend required to run Vega. If you don't have one of those available, follow instructions in the (Saga readme)[https://github.com/VegaPublish/saga]. If setting up Saga seems like a daunting task, ask your local IT guru to do it for you :) + +**Vega** is the editing environment which runs in the browser and makes editors happy. +**Lyra** is the UI platform which Vega runs on. + +## Initialize a new Vega instance + +The platform which Vega is built on is called `lyra`. To start, install the `lyra` command line interface: + +``` +npm install -g @lyra/cli +``` + +Then, run the setup wizard with: + +``` +lyra init +``` + +You will be prompted for the dataset name associated with the Venue, the URL for the Saga backend API, and a couple of other things. Follow the instructions. + +When completed, you have have a project folder with a new Vega instance. `cd` to that folder and run `lyra start`. Then open your browser and point it to the URL prompted to you in the terminal. + +Congratulations, you have Vega running! From 1de6f6dbb23c66a2a7eec51eb88d9f0cebb9c816 Mon Sep 17 00:00:00 2001 From: benjamespoet Date: Sat, 9 May 2020 13:14:29 -0500 Subject: [PATCH 2/4] fixing saga link --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 06bba8f..eb723ea 100644 --- a/readme.md +++ b/readme.md @@ -12,7 +12,7 @@ ## Saga, Lyra, Vega? -**Saga** is the backend required to run Vega. If you don't have one of those available, follow instructions in the (Saga readme)[https://github.com/VegaPublish/saga]. If setting up Saga seems like a daunting task, ask your local IT guru to do it for you :) +**Saga** is the backend required to run Vega. If you don't have one of those available, follow instructions in the [Saga readme](https://github.com/VegaPublish/saga). If setting up Saga seems like a daunting task, ask your local IT guru to do it for you :) **Vega** is the editing environment which runs in the browser and makes editors happy. **Lyra** is the UI platform which Vega runs on. From 4d260ec62bc693b2a4336592e3dda1770d6c3aa6 Mon Sep 17 00:00:00 2001 From: benjamespoet Date: Sat, 9 May 2020 13:16:07 -0500 Subject: [PATCH 3/4] removing README to remove multiple versions of file --- README.md | 38 -------------------------------------- readme.md | 38 -------------------------------------- 2 files changed, 76 deletions(-) delete mode 100644 README.md delete mode 100644 readme.md diff --git a/README.md b/README.md deleted file mode 100644 index 06bba8f..0000000 --- a/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# Vega - -[![Build Status](https://travis-ci.org/VegaPublish/vega.svg?branch=master)](https://travis-ci.org/VegaPublish/vega) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) - -# Getting started - -## Prerequisites - -* Node.js 8.x or later -* npm v6.0 or later -* A running instance of Saga - -## Saga, Lyra, Vega? - -**Saga** is the backend required to run Vega. If you don't have one of those available, follow instructions in the (Saga readme)[https://github.com/VegaPublish/saga]. If setting up Saga seems like a daunting task, ask your local IT guru to do it for you :) - -**Vega** is the editing environment which runs in the browser and makes editors happy. -**Lyra** is the UI platform which Vega runs on. - -## Initialize a new Vega instance - -The platform which Vega is built on is called `lyra`. To start, install the `lyra` command line interface: - -``` -npm install -g @lyra/cli -``` - -Then, run the setup wizard with: - -``` -lyra init -``` - -You will be prompted for the dataset name associated with the Venue, the URL for the Saga backend API, and a couple of other things. Follow the instructions. - -When completed, you have have a project folder with a new Vega instance. `cd` to that folder and run `lyra start`. Then open your browser and point it to the URL prompted to you in the terminal. - -Congratulations, you have Vega running! diff --git a/readme.md b/readme.md deleted file mode 100644 index eb723ea..0000000 --- a/readme.md +++ /dev/null @@ -1,38 +0,0 @@ -# Vega - -[![Build Status](https://travis-ci.org/VegaPublish/vega.svg?branch=master)](https://travis-ci.org/VegaPublish/vega) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) - -# Getting started - -## Prerequisites - -* Node.js 8.x or later -* npm v6.0 or later -* A running instance of Saga - -## Saga, Lyra, Vega? - -**Saga** is the backend required to run Vega. If you don't have one of those available, follow instructions in the [Saga readme](https://github.com/VegaPublish/saga). If setting up Saga seems like a daunting task, ask your local IT guru to do it for you :) - -**Vega** is the editing environment which runs in the browser and makes editors happy. -**Lyra** is the UI platform which Vega runs on. - -## Initialize a new Vega instance - -The platform which Vega is built on is called `lyra`. To start, install the `lyra` command line interface: - -``` -npm install -g @lyra/cli -``` - -Then, run the setup wizard with: - -``` -lyra init -``` - -You will be prompted for the dataset name associated with the Venue, the URL for the Saga backend API, and a couple of other things. Follow the instructions. - -When completed, you have have a project folder with a new Vega instance. `cd` to that folder and run `lyra start`. Then open your browser and point it to the URL prompted to you in the terminal. - -Congratulations, you have Vega running! From 5bfc2df1ac18e051c383d63c1cd27738b9ea7a1d Mon Sep 17 00:00:00 2001 From: benjamespoet Date: Sat, 9 May 2020 13:16:57 -0500 Subject: [PATCH 4/4] adding README.md (as opposed to readme.md, which causes errors) --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb723ea --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Vega + +[![Build Status](https://travis-ci.org/VegaPublish/vega.svg?branch=master)](https://travis-ci.org/VegaPublish/vega) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) + +# Getting started + +## Prerequisites + +* Node.js 8.x or later +* npm v6.0 or later +* A running instance of Saga + +## Saga, Lyra, Vega? + +**Saga** is the backend required to run Vega. If you don't have one of those available, follow instructions in the [Saga readme](https://github.com/VegaPublish/saga). If setting up Saga seems like a daunting task, ask your local IT guru to do it for you :) + +**Vega** is the editing environment which runs in the browser and makes editors happy. +**Lyra** is the UI platform which Vega runs on. + +## Initialize a new Vega instance + +The platform which Vega is built on is called `lyra`. To start, install the `lyra` command line interface: + +``` +npm install -g @lyra/cli +``` + +Then, run the setup wizard with: + +``` +lyra init +``` + +You will be prompted for the dataset name associated with the Venue, the URL for the Saga backend API, and a couple of other things. Follow the instructions. + +When completed, you have have a project folder with a new Vega instance. `cd` to that folder and run `lyra start`. Then open your browser and point it to the URL prompted to you in the terminal. + +Congratulations, you have Vega running!