Skip to content

Commit

Permalink
Merge pull request #259 from Human-Connection/update-readme
Browse files Browse the repository at this point in the history
Remove irrelevant information from README
  • Loading branch information
roschaefer authored Sep 18, 2018
2 parents f21bad3 + a471601 commit 3e387a8
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,18 @@
> **Note:** This is only the WebApp part of Human-Connection, you have to also checkout the [API](https://github.com/Human-Connection/API) which is used by this WebApp.
This is the nuxt + express version of our WebApp as nuxt.js seams to be more stable and we have better options for keeping it updated.

## Build Setup

> we recommend to install the project locally for the best development ease and performance
## Local Installation

Run:
``` bash
# install dependencies
$ yarn
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
# build once and launch server
$ yarn build
$ yarn start
```

Expand All @@ -40,15 +38,6 @@ For detailed explanation on how things work, checkout the [Nuxt.js docs](https:/

> More information on environment variables can be found in the [documentation (WIP)](https://docs.human-connection.org/environments/docker-test-production/docker-configuration.html)
#### Maintenance

You can start the app in maintenance mode so it does not ask the api in case it is down.
```
$ env MAINTENANCE=true yarn dev
# or start
$ env MAINTENANCE=true yarn start
```

### Test Logins


Expand All @@ -64,14 +53,10 @@ $ env MAINTENANCE=true yarn start
The Developer Style Guide provides important infos about components and styles. To start it simply type:

``` bash
$ npm run styleguide
$ yarn run styleguide
```
When built you can open it at [http://localhost:6060](http://localhost:6060)

## Backpack

We use [backpack](https://github.com/palmerhq/backpack) to watch and build the application, so you can use the latest ES6 features (module syntax, async/await, etc.).

## Help

The HC platform is documented in our [docs](https://docs.human-connection.org/) (work in progress).<br>
Expand Down

0 comments on commit 3e387a8

Please sign in to comment.