Skip to content

Commit

Permalink
Merge pull request #293 from christianeiselt/Centralize_read_me_conte…
Browse files Browse the repository at this point in the history
…nt_to_docs.human_connection.org

Centralize read me content to docs.human connection.org
  • Loading branch information
Lulalaby authored Sep 20, 2018
2 parents bd6b7d2 + 28372f9 commit adad1da
Showing 1 changed file with 6 additions and 58 deletions.
64 changes: 6 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,65 +13,13 @@
</p>

# 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.<br />
It uses the Nuxt.js and Express.js projects.<br />

## Help

The HC platform is documented in our [docs](https://docs.human-connection.org/) (work in progress).<br>
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).<br />
Connect with other developers over [Discord](https://discord.gg/mVmjvNF)<br />

## 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)<br />
Licensed under the [MIT](https://github.com/Human-Connection/WebApp/blob/develop/LICENSE.md) license.<br />

0 comments on commit adad1da

Please sign in to comment.