From e910febf6f598f0aefc038fe26c3ede5fc025715 Mon Sep 17 00:00:00 2001 From: Christian Eiselt Date: Wed, 19 Sep 2018 18:50:41 +0200 Subject: [PATCH 1/2] Standardise ReadMe.md --- README.md | 64 ++++++------------------------------------------------- 1 file changed, 6 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 2cb76720..afba89fb 100644 --- a/README.md +++ b/README.md @@ -13,65 +13,13 @@

# 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](https://github.com/Human-Connection/API) which is used by this WebApp. - -## Local Installation - -Run: -``` bash -# install dependencies -$ yarn install - -# serve with hot reload at localhost:3000 -$ yarn dev - -# build once and launch server -$ yarn build -$ yarn start -``` - -For detailed explanation on how things work, checkout the [Nuxt.js docs](https://github.com/nuxt/nuxt.js). - -## Env Vars - -> More information on environment variables can be found in the [documentation (WIP)](https://docs.human-connection.org/environments/docker-test-production/docker-configuration.html) - -### Test Logins - - -| Role | E-Mail | Password | -| --------- | -------------- | -------- | -| Admin | test@test.de | 1234 | -| Moderator | test2@test2.de | 1234 | -| User | test3@test3.de | 1234 | - - -## Styleguide - -The Developer Style Guide provides important infos about components and styles. To start it simply type: - -``` bash -$ yarn run styleguide -``` -When built you can open it at [http://localhost:6060](http://localhost:6060) - -## Localization - -### Located in two places! - -`locales/` - -[Lokalise.co](https://lokalise.co/public/829625945b3c04bf56d560.80490143/) +This is the frontend of HC.
+It uses the Nuxt.js and Express.js projects.
## Help - -The HC platform is documented in our [docs](https://docs.human-connection.org/) (work in progress).
-Connect with other developers over [Discord](https://discord.gg/mVmjvNF). +The HC platform and its setup is documented in our [docs](https://docs.human-connection.org/) (work in progress).
+You can get help here too: https://discord.gg/mVmjvNF
## License - -Copyright (c) 2018 [Human-Connection.org](https://human-connection.org) - -Licensed under the [MIT](https://github.com/Human-Connection/WebApp/blob/develop/LICENSE.md) license. +Copyright (c) 2018 [Human-Connection.org](https://human-connection.org)
+Licensed under the [MIT](https://github.com/Human-Connection/WebApp/blob/develop/LICENSE.md) license.
From 28372f993c97df2b7fb002da2a4a48b0fa7b9ded Mon Sep 17 00:00:00 2001 From: Christian Eiselt Date: Thu, 20 Sep 2018 23:23:12 +0200 Subject: [PATCH 2/2] Merge relevant edits from last commits. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index afba89fb..05c0efed 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ It uses the Nuxt.js and Express.js projects.
## Help The HC platform and its setup is documented in our [docs](https://docs.human-connection.org/) (work in progress).
-You can get help here too: https://discord.gg/mVmjvNF
+Connect with other developers over [Discord](https://discord.gg/mVmjvNF)
## License Copyright (c) 2018 [Human-Connection.org](https://human-connection.org)