https://github.com/wolven531/awillwebapp
A repository used to experiment with modern dotnet and React technologies
https://github.com/wolven531/awillwebapp
brotli cypress dotnet dotnet-core javascript node nodejs react redux typescript visual-studio-code
Last synced: 2 months ago
JSON representation
A repository used to experiment with modern dotnet and React technologies
- Host: GitHub
- URL: https://github.com/wolven531/awillwebapp
- Owner: Wolven531
- Created: 2018-07-21T16:03:27.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-26T05:56:39.000Z (over 7 years ago)
- Last Synced: 2025-09-13T16:50:59.258Z (9 months ago)
- Topics: brotli, cypress, dotnet, dotnet-core, javascript, node, nodejs, react, redux, typescript, visual-studio-code
- Language: C#
- Homepage:
- Size: 13.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AWillWebApp
This repository makes use of several modern frontend and backend technologies and can be used as a testing / starting point for those looking to experiment with said technologies.
## Technologies / Frameworks
* dotnet core (`2.1.4xx`)
* Cypress (`3.1.0`)
* NodeJS (`10.10.0`)
* NPM (`6.4.1`)
* React (`16.4.2`) (Typescript variant)
* Redux (`4.0.0`)
* Visual Studio Code (for tasks)
## Current Code Coverage
 Combined Coverage (SVG that animates between Branch and Line)
 Branch Coverage
 Line Coverage
## Setup
* Install Chocolatey (instructions [here](https://chocolatey.org/docs/installation#installing-chocolatey))
* Install NodeJS: `choco install nodejs -y`
* Update NPM: `npm i -g npm@latest`
* Install frontend dependencies: `npm install` from `/AWillWebApp/ClientApp/`
* Install backend dependencies `dotnet restore` from `/`
* Trust local certs for HTTPS: `dotnet dev-certs https --trust`
## First Run
When visiting [https://localhost:5001](https://localhost:5001) for the first time on a machine, you will likely get a security exception.
Make sure to add `https://localhost:5001` to the trusted list of exceptions for that machine, otherwise the site will be unusable on that machine (screenshot below is from Firefox).
## Running
The easiest way to run any part of this project is to use the Visual Studio Code editor (available [here](https://code.visualstudio.com/)) and its task runner. The following tasks are defined in `/.vscode/tasks.json`:
* `Build dotnet app` - Use the dotnet core CLI to compile the application
* `Run dotnet app` - Use the dotnet core CLI to run the application (runs insecure HTTP on port `5000`, secure HTTPS on `5001`)
* `Run webpack watcher` - Use the webpack CLI to track file changes for the React app and recompile on change (watches `/AWillWebApp/AWillWebApp/ClientApp/*`)
* `Get C# Code Coverage` - Use the dotnet core CLI (dotnet test) to run tests and collect code coverage (outputs in opencover format to `/AWillWebApp/AWillWebApp.Tests/coverage.opencover.xml`)
* `Run all coverage conversions` - Use the dotnet core CLI and ReportGenerator tool to convert the opencover coverage report to a more human-friendly HTML report
* **NOTE**: This task requires you have the ReportGenerator tool installed. You can run the `Install dotnet ReportGenerator` command listed in the `Commands` section below or see further instructions [here](https://danielpalme.github.io/ReportGenerator/usage.html)
* `View coverage report in browser` - Launch the system default browser to the local file URL where the HTML report resides
* **NOTE**: Not all of the report files are tracked in the repository, so make sure to run the `Convert coverage to report` task prior to this task
### Commands
#### Install dotnet ReportGenerator
```DOS
dotnet tool install --global dotnet-reportgenerator-globaltool --version 4.0.0-rc5
```