CyberRegister/CyberRegister

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Cyberregister
[![Build Status](https://travis-ci.org/CyberRegister/CyberRegister.svg)](https://travis-ci.org/CyberRegister/CyberRegister)
[![CodeClimate maintainability](https://api.codeclimate.com/v1/badges/d06b9ceaf76db20fd066/maintainability)](https://codeclimate.com/github/CyberRegister/CyberRegister/maintainability)
[![CodeClimate test coverage](https://api.codeclimate.com/v1/badges/d06b9ceaf76db20fd066/test_coverage)](https://codeclimate.com/github/CyberRegister/CyberRegister/test_coverage)
[![Codacy grade](https://api.codacy.com/project/badge/Grade/372524fda06445b7a6197030f6eda63c)](https://www.codacy.com/app/CyberRegister/CyberRegister?utm_source=github.com&utm_medium=referral&utm_content=CyberRegister/CyberRegister&utm_campaign=Badge_Grade)
[![Codacy coverage](https://api.codacy.com/project/badge/Coverage/372524fda06445b7a6197030f6eda63c)](https://www.codacy.com/app/CyberRegister/CyberRegister?utm_source=github.com&utm_medium=referral&utm_content=CyberRegister/CyberRegister&utm_campaign=Badge_Coverage)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/CyberRegister/CyberRegister/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/CyberRegister/CyberRegister/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/CyberRegister/CyberRegister/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/CyberRegister/CyberRegister/?branch=master)
[![Build Status](https://scrutinizer-ci.com/g/CyberRegister/CyberRegister/badges/build.png?b=master)](https://scrutinizer-ci.com/g/CyberRegister/CyberRegister/build-status/master)
[![Code Intelligence Status](https://scrutinizer-ci.com/g/CyberRegister/CyberRegister/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)
[![StyleCI](https://styleci.io/repos/120670007/shield?branch=master)](https://styleci.io/repos/120670007)
[![codecov](https://codecov.io/gh/CyberRegister/CyberRegister/branch/master/graph/badge.svg)](https://codecov.io/gh/CyberRegister/CyberRegister)
[![CodeFactor](https://www.codefactor.io/repository/github/cyberregister/cyberregister/badge)](https://www.codefactor.io/repository/github/cyberregister/cyberregister)
[![Badges](https://img.shields.io/badge/badges-16-green.svg)](https://shields.io)
[![Cyberveiligheid](https://img.shields.io/badge/Cyberveiligheid-97%25-yellow.svg)](https://eurocyber.nl)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FCyberRegister%2FCyberRegister.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FCyberRegister%2FCyberRegister?ref=badge_shield)
![Node.js build and lint](https://github.com/CyberRegister/CyberRegister/workflows/Node.js%20build%20and%20lint/badge.svg)
![Laravel](https://github.com/CyberRegister/CyberRegister/workflows/Laravel/badge.svg)

Installation:
```bash
composer install
cp .env.example .env      # Edit config
php artisan key:generate
php artisan migrate
php artisan passport:keys
yarn install
yarn production
```
## License

Cyberregister is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).

The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).


[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FCyberRegister%2FCyberRegister.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FCyberRegister%2FCyberRegister?ref=badge_large)

## Development

Running the development server:
```bash
php artisan serve
```
Frontend development:
```bash
yarn dev
```
With live-reload:
```bash
yarn watch
```
## Running tests
 
Run all the tests
```bash
vendor/bin/pest
```
Run a test suite (for a list of availabe suites, see `/phpunit.xml`)
```bash 
vendor/bin/pest --testsuite <suite_name>
```
Run a specific test file
```bash
vendor/bin/pest tests/<optional_folders>/TestFileName
```
Run a specific test case
``bash
vendor/bin/pest --filter <test_case_name>
``
Generate code coverage
```bash
vendor/bin/pest --coverage-html docs/coverage
```
This will create the code coverage docs in `docs/coverage/index.html`