Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/versioned/versioned-admin

Versioned Admin UI
https://github.com/versioned/versioned-admin

Last synced: 4 days ago
JSON representation

Versioned Admin UI

Awesome Lists containing this project

README

        

# Versioned Admin UI

This is the Versioned admin web UI that talks to the [Versioned REST API](https://github.com/versioned/versioned-api).

## Documentation

Documentation is available at [versioned-doc](https://github.com/versioned/versioned-doc)

## Hosted/Managed Service

A hosted and managed version of this UI is available at [versioned.io](http://versioned.io)

## Starting the Development Server

```sh
npm install
npm run dev
open http://localhost:8080
```

To create a production build, run `npm run build`

## Environment Variables

```sh
VUE_APP_ALGOLIASEARCH_APPLICATION_ID=...
VUE_APP_API_URL=https://api.versioned.io/v1
VUE_APP_DOCS_URL=https://github.com/versioned/versioned-doc
VUE_APP_ENV=production
VUE_APP_GOOGLE_API_KEY=...
```

## Heroku Deploy

```sh
heroku config:set VUE_APP_API_URL=https://name-of-versioned-api-app.herokuapp.com/v1
```

## Unit Tests

Running:

```sh
npm run test:unit --watch
```

See [@vue/cli-plugin-unit-jest](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-unit-jest)

## End-to-End/Integration Tests

The dedicated_space.js spec requires these environment variables:

```sh
CYPRESS_MONGODB_URL
CYPRESS_ALGOLIASEARCH_APPLICATION_ID
CYPRESS_ALGOLIASEARCH_API_KEY
```

Running in the browser (all specs or single spec):

```sh
npm run test:e2e
```

Running headless:

```sh
npm run test:e2e --headless
```

Running single spec headless:

```sh
npm run test:e2e --headless --spec tests/e2e/specs/dedicated_space.js
```