Skip to content

Commit

Permalink
Upgrade README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vikoivun committed Nov 27, 2017
1 parent f86a68f commit ddcdddf
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,33 @@
Linkedevents-UI - form-style UI for Linked Events API
=====================================================

[![Build status](https://travis-ci.org/City-of-Helsinki/linkedevents-ui.svg?branch=master)](https://travis-ci.org/City-of-Helsinki/linkedevents-ui)
[![codecov](https://codecov.io/gh/City-of-Helsinki/linkedevents-ui/branch/master/graph/badge.svg)](https://codecov.io/gh/City-of-Helsinki/linkedevents-ui)

# Installation
Linkedevents-UI is a user interface for creating and changing events through
Linked Events API. It exposes many capabilities of the API including:

```
$ npm install
$ npm start
```
* Creation, changing and deletion of events
* Managing multipart events
* Showing available actions based on user permissions

Then point your browser to the webpack dev server at http://localhost:8080/.
# Development Installation

## Prerequisites
* Yarn
* Node v8 LTS

If you're doing API development as well, set your API endpoint in your
local config file at `config/local.yml`, for example:
## Configuration

api_base: http://localhost:8000/v1
config_dev.json contains partially working settings giving you read only
access to our test API. If you have your own API and/or authentication
server you can change the relevant settings therein.

For server or development server (used for authorization environment), set appropriate variables also in respective server modules.
## Running development server

```
$ yarn
$ yarn start
```

Then point your browser to the webpack dev server at http://localhost:8080/.

0 comments on commit ddcdddf

Please sign in to comment.