README.md
# CaPE - Modeler - Frontend
> Repository for the Frontend of the CaPE - Modeler
:rocket: **Available at [https://cape-modeler.gitlab.io/frontend/](https://cape-modeler.gitlab.io/frontend/) or [as Download](https://github.com/BerniWittmann/cape-frontend/releases/latest).**
[](https://gitlab.com/cape-modeler/frontend/commits/master)
[](https://dashboard.cypress.io/#/projects/6623by/runs)
[](https://codeclimate.com/github/BerniWittmann/cape-frontend/test_coverage)
[](https://codeclimate.com/github/BerniWittmann/cape-frontend/maintainability)
[](https://gitlab.com/cape-modeler/frontend)
[](https://cape-modeler.gitlab.io/frontend/)
[](https://github.com/BerniWittmann/cape-frontend/releases/latest)
---
## :package: Download
The App is either as Browser App at [https://cape-modeler.gitlab.io/frontend/](https://cape-modeler.gitlab.io/frontend/) available or as native App for Mac, Windows und Linux [for Download](https://github.com/BerniWittmann/cape-frontend/releases/latest) available.
## :book: Wiki
The Documentation, Guidelines and more can be found in the [Confluence - Wiki](https://portal.dbis.info/confluence/display/CM)
## :inbox_tray: Task Tracker
All Tasks are managed with [JIRA](https://portal.dbis.info/jira/projects/CM/summary)
## :clipboard: Changelog
The [Changelog](https://gitlab.com/cape-modeler/frontend/blob/master/CHANGELOG.md) lists all Changes
## :flashlight: Coding Guidelines
The [Coding-Guidelines](https://portal.dbis.info/confluence/display/CM/Coding+Guidelines) inform about the Workflow and general Development-Guidelines
## :file_folder: File Structure
An Explanation of the [File-Structure](https://portal.dbis.info/confluence/display/CM/Dateistruktur) can be found in the Wiki
## :mag: E2E-Test Dashboard
The E2E Tests are recorded and are available on the [Cypress Dashboard](https://dashboard.cypress.io/#/projects/6623by/runs)
## :bar_chart: Code Climate Dashboard
The Results from the StaticCode Analysis can be found on the [Code Climate Dashboard](https://codeclimate.com/github/BerniWittmann/cape-frontend)
## :computer: Technology-Stack
The Wiki also informs about the used [Technology-Stack](https://portal.dbis.info/confluence/display/CM/Technologie+Stack)
## :question: FAQ
The [FAQ-Page](https://portal.dbis.info/confluence/display/CM/FAQ) answers some open Questions
## :gear: Project Setup
Install Dependencies
```
npm install
```
### Development Server
Start the Development Server inclusive Hot-Reloading
```
npm run serve
```
### Electron Development
Start an Development Version of the Electron App
```
npm run electron:servce
```
### Production Build
Compile and Minify the Code for Production
```
npm run build
```
### Electron Build
Build the Electron Apps
```
npm run electron:build
```
### Linting
Check the Code according to Coding-Standards (*linten*) and automatically fix them if possible
```
npm run lint
```
### Unit Tests
Execute the Unit tests
```
npm run test:unit
```
Execute the Unit tests and automatically rerun them on file changes
```
npm run test:unit:watch
```
### E2E Tests
Execute the End-to-End Tests
```
npm run test:e2e
```
### Generate Component Documentation
Generate the Documentation for the components
```
npm run docs
```
## :bookmark_tabs: License
MIT License
Copyright (c) 2018 Alexander Fischer, Lukas Jesche, Bernhard Wittmann
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.