# VSETH - Frontend

This repository contains most packages used by VSETH Frontend projects. For more information, please consult [the frontend docs](https://fe.vseth.ethz.ch).

## Setup - Using VS Code Remote Devcontainer

1. Clone the repo
   `$ git clone git@gitlab.ethz.ch:vseth/0403-isg/sip-infrastructure/vseth-frontend.git`

2. Open folder with VS Code Insider Edition with installed VS Code Remote Extension.

3. Click on pop-up asking to open the folder in a container.

4. Wait for the container to build.

5. run `yarn run watch` or `yarn run build` to build the packages

6. run `yarn run docs` to serve the docs (you may have to forward the ports, to do so, open the VSCode Command Palette and type in `Forward Port from Container`. The docs need port 5000 and 54321 )

## Setup - Locally

### Pre-requisites

- _Node:_ `^9.0.0` or higher
- _Npm:_ `6.0.0` or higher
- _Yarn:_ `^1.7.0` or higher (required!)

### Install

Go to `vseth-frontend` directory after checking out the repository:

```bash
$ cd vseth-frontend
```

Then run the following commands to bootstrap all dependencies:

With `yarn`:

```bash
$ yarn
```

## Developing

Publishing the packages to npm currently requires the action of an admin (Moritz Schneider).

## Documentation

For more information, run the documentation with `yarn run dev:docs` or check out [the frontend docs](https://fe.vseth.ethz.ch).

TODO: publish from ci with from-git

# VSETH Components

## Version 2.0.0

Following components are planned for 2.0:

    - Buttons, Tags and Button groups
    - Forms, Input
    - Tabs
    - Tooltips
    - Navbar and Mobile Nav
    - Icons
    - Footer
    - Cards
    - Rating (already exists)

Following components are planned but will be implemented later:

    - Breadcrumbs
    - Tables
    - Graphs
    - Pagination