Skip to content
Snippets Groups Projects
README.md 660 B
Newer Older
scmoritz's avatar
scmoritz committed
# AMIV website

This is the home of the new AMIV website.

## How to use

Sandro Lutz's avatar
Sandro Lutz committed
### Development

```bash
npm install
npm run server  #start developer server
Sandro Lutz's avatar
Sandro Lutz committed
### Production

```bash
npm install
npm run build
```
Sandro Lutz's avatar
Sandro Lutz committed

Then copy `index.html` and the dist folder to your webhost.

Sandro Lutz's avatar
Sandro Lutz committed
### Lint

```bash
npm run lint
```
Sandro Lutz's avatar
Sandro Lutz committed
### Documentation

```bash
npm run docs    # output format: HTML
npm run docs-md # output format: markdown
```

## Developer
scmoritz's avatar
scmoritz committed

Backend: [AMIV API](https://github.com/amiv-eth/amivapi)

Technologies:
lic's avatar
lic committed

Sandro Lutz's avatar
Sandro Lutz committed
* [Mitrhil](https://mithril.js.org/)

lic's avatar
lic committed
Needed extensions:
Sandro Lutz's avatar
Sandro Lutz committed

* [ESlint](https://github.com/eslint/eslint)
* [Prettier](https://github.com/prettier/prettier)