Skip to content

BerniWittmann/cape-frontend

Repository files navigation

CaPE - Modeler - Frontend

Repository for the Frontend of the CaPE - Modeler

🚀 Available at https://cape-modeler.gitlab.io/frontend/ or as Download.

Pipeline Status Cypress Dashboard Test Coverage Maintainability GitLab Newest Version Download

📦 Download

The App is either as Browser App at https://cape-modeler.gitlab.io/frontend/ available or as native App for Mac, Windows und Linux for Download available.

📖 Wiki

The Documentation, Guidelines and more can be found in the Confluence - Wiki

📥 Task Tracker

All Tasks are managed with JIRA

📋 Changelog

The Changelog lists all Changes

🔦 Coding Guidelines

The Coding-Guidelines inform about the Workflow and general Development-Guidelines

📁 File Structure

An Explanation of the File-Structure can be found in the Wiki

🔍 E2E-Test Dashboard

The E2E Tests are recorded and are available on the Cypress Dashboard

📊 Code Climate Dashboard

The Results from the StaticCode Analysis can be found on the Code Climate Dashboard

💻 Technology-Stack

The Wiki also informs about the used Technology-Stack

❓ FAQ

The FAQ-Page answers some open Questions

⚙️ 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

📑 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.