Skip to content

Latest commit

 

History

History
96 lines (63 loc) · 3.22 KB

File metadata and controls

96 lines (63 loc) · 3.22 KB

Human Connection

Build Status Discord

Human-Connection WebApp

uses the Nuxt.js and Express.js projects

Note: This is only the WebApp part of Human-Connection, you have to also checkout the 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.

Local installation

we recommend to install the project locally for the best development ease and performance

# install dependencies
$ yarn

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

# build for production and launch server
$ yarn start

Create your individual set of environment variables:

$ cp .env.example .env
# now open .env and change it according to your setup

For detailed explanation on how things work, checkout the Nuxt.js docs.

Env Vars

More information on environment variables can be found in the documentation (WIP)

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

Admin

E-Mail: test@test.de
Password: 1234

Moderator

E-Mail: test2@test2.de
Password: 1234

Normal User

E-Mail: test3@test3.de
Password: 1234

Styleguide

The Developer Style Guide provides important infos about components and styles. To start it simply type:

$ npm run styleguide

When built you can open it at http://localhost:6060

Backpack

We use 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 gitbook (work in progress).

License

Copyright (c) 2018 Human-Connection.org

Licensed under the MIT license.