FR-104 Merge the FlightRecorder business logic, API and UI repositories

.gitattributes

@@ -0,0 +1 @@
+src/FlightRecorder.Mvc/wwwroot/* linguist-vendored

.github/workflows/dotnetcore.yml

@@ -4,40 +4,39 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
-    - name: Setup .NET Core
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 7.0.302
-    - name: Set up JDK 11
-      uses: actions/setup-java@v1
-      with:
-        java-version: 1.11
-    - name: Cache SonarCloud packages
-      uses: actions/cache@v1
-      with:
-        path: ~\sonar\cache
-        key: ${{ runner.os }}-sonar
-        restore-keys: ${{ runner.os }}-sonar
-    - name: Install SonarCloud scanners
-      run: |
-        dotnet tool install --global dotnet-sonarscanner
-    - name: Build and analyze
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
-        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-      run: |
-        dotnet-sonarscanner begin /k:"davewalker5_FlightRecorderDb" /o:"davewalker5" /d:sonar.login="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io"
-        dotnet build --configuration Release src/FlightRecorderDb.sln
-        dotnet-sonarscanner end /d:sonar.login="${{ secrets.SONAR_TOKEN }}"
-    - name: Run unit tests and generate code coverage
-      run: dotnet test src/FlightRecorderDb.sln /p:CollectCoverage=true /p:CoverletOutput=coverage/ /p:CoverletOutputFormat=lcov
-    - name: Generage Coveralls code coverage
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        path-to-lcov: src/FlightRecorder.Tests/coverage/coverage.info
+      - uses: actions/checkout@v1
+      - name: Setup .NET Core
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: 7.0.302
+      - name: Set up JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: 19
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v1
+        with:
+          path: ~\sonar\cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Install SonarCloud scanners
+        run: |
+          dotnet tool install --global dotnet-sonarscanner
+      - name: Build and analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: |
+          dotnet-sonarscanner begin /k:"davewalker5_FlightRecorderDb" /o:"davewalker5" /d:sonar.login="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io"
+          dotnet build --configuration Release src/FlightRecorderDb.sln
+          dotnet-sonarscanner end /d:sonar.login="${{ secrets.SONAR_TOKEN }}"
+      - name: Run unit tests and generate code coverage
+        run: dotnet test src/FlightRecorderDb.sln /p:CollectCoverage=true /p:CoverletOutput=coverage/ /p:CoverletOutputFormat=lcov
+      - name: Generage Coveralls code coverage
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: src/FlightRecorder.Tests/coverage/coverage.info

.gitignore

@@ -405,3 +405,6 @@ ASALocalRun/
 .localhistory/
 
 data/
+bin
+obj
+.DS_Store

README.md

@@ -1,24 +1,24 @@
-# FlightRecorderDb
+# FlightRecorder
 
-[![Build Status](https://github.com/davewalker5/FlightRecorderDb/workflows/.NET%20Core%20CI%20Build/badge.svg)](https://github.com/davewalker5/FlightRecorderDb/actions)
-[![GitHub issues](https://img.shields.io/github/issues/davewalker5/FlightRecorderDb)](https://github.com/davewalker5/FlightRecorderDb/issues)
-[![Coverage Status](https://coveralls.io/repos/github/davewalker5/FlightRecorderDb/badge.svg?branch=master)](https://coveralls.io/github/davewalker5/FlightRecorderDb?branch=master)
-[![Releases](https://img.shields.io/github/v/release/davewalker5/FlightRecorderDb.svg?include_prereleases)](https://github.com/davewalker5/FlightRecorderDb/releases)
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/davewalker5/FlightRecorderDb/blob/master/LICENSE)
-[![Language](https://img.shields.io/badge/language-c%23-blue.svg)](https://github.com/davewalker5/FlightRecorderDb/)
-[![Language](https://img.shields.io/badge/database-SQLite-blue.svg)](https://github.com/davewalker5/FlightRecorderDb/)
-[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/davewalker5/FlightRecorderDb)](https://github.com/davewalker5/FlightRecorderDb/)
+[![Build Status](https://github.com/davewalker5/FlightRecorder/workflows/.NET%20Core%20CI%20Build/badge.svg)](https://github.com/davewalker5/FlightRecorder/actions)
+[![GitHub issues](https://img.shields.io/github/issues/davewalker5/FlightRecorder)](https://github.com/davewalker5/FlightRecorder/issues)
+[![Coverage Status](https://coveralls.io/repos/github/davewalker5/FlightRecorder/badge.svg?branch=master)](https://coveralls.io/github/davewalker5/FlightRecorder?branch=master)
+[![Releases](https://img.shields.io/github/v/release/davewalker5/FlightRecorder.svg?include_prereleases)](https://github.com/davewalker5/FlightRecorder/releases)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/davewalker5/FlightRecorder/blob/master/LICENSE)
+[![Language](https://img.shields.io/badge/language-c%23-blue.svg)](https://github.com/davewalker5/FlightRecorder/)
+[![Language](https://img.shields.io/badge/database-SQLite-blue.svg)](https://github.com/davewalker5/FlightRecorder/)
+[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/davewalker5/FlightRecorder)](https://github.com/davewalker5/FlightRecorder/)
 
-## About FlightRecorderDb
+## About
 
-FlightRecorderDb implements the entities and business logic for a SQL-based aircraft sightings logbook.
+FlightRecorder implements a SQL-based aircraft sightings logbook. A ASP.NET WenAPI provides access to the business logic and data access layer while an ASP.NET MVC UI provides the user interface.
 
 Each sighting consists of the following data:
 
 - Flight details
   - Flight number
-  - Embarkation airport
-  - Destination
+  - Embarkation airport IATA code
+  - Destination IATA code
   - Airline
 - Aircraft details
   - Registration details
@@ -29,18 +29,60 @@ Each sighting consists of the following data:
   - Altitude when sighted
   - Location
 
+A register of airport codes by country is used to validate airport IATA codes.
+
+Sightings may be searched by:
+
+- Route, specified as airport IATA codes
+- Flight number
+- Airline name
+- Aircraft registration number
+- Date
+
+The following reports can be generated and exported to CSV format files:
+
+- Airline statistics
+- Flights by month
+- Location statistics
+- Manufacturer statistics
+- Aircraft model statistics
+
+The following data can be exported in CSV format:
+
+- Sightings
+- Airport code and country list
+
 ## Getting Started
 
-Please see the [Wiki](https://github.com/davewalker5/FlightRecorderDb/wiki) for details on how to reference and use the Flight Recorder business logic and how to get started with a database to hold the data.
+Please see the [Wiki](https://github.com/davewalker5/FlightRecorder/wiki) for configuration details and the user guide.
 
 ## Authors
 
-- **Dave Walker** - *Initial work* - [LinkedIn](https://www.linkedin.com/in/davewalker5/)
+- **Dave Walker** - _Initial work_ - [LinkedIn](https://www.linkedin.com/in/davewalker5/)
+
+## Feedback
+
+To file issues or suggestions, please use the [Issues](https://github.com/davewalker5/FlightRecorder/issues) page for this project on GitHub.
+
+## License
+
+# This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Credits
+
+Implementation of authentication using JWT in the REST API is based on the following tutorial:
+
+- https://github.com/cornflourblue/aspnet-core-3-jwt-authentication-api
+- https://jasonwatmore.com/post/2019/10/11/aspnet-core-3-jwt-authentication-tutorial-with-example-api#users-controller-cs
+
+The Flight Recorder MVC project uses the Gijgo JavaScript controls library:
+
+- https://gijgo.com
 
 ## Feedback
 
-To file issues or suggestions, please use the [Issues](https://github.com/davewalker5/FlightRecorderDb/issues) page for this project on GitHub.
+To file issues or suggestions, please use the [Issues](https://github.com/davewalker5/FlightRecorder/issues) page for this project on GitHub.
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

docker/api/Dockerfile

@@ -0,0 +1,4 @@
+FROM mcr.microsoft.com/dotnet/core/aspnet:latest
+COPY flightrecorder.api-1.7.0.0 /opt/flightrecorder.api-1.7.0.0
+WORKDIR /opt/flightrecorder.api-1.7.0.0/bin
+ENTRYPOINT [ "./FlightRecorder.Api" ]

docker/api/README.md

@@ -0,0 +1,98 @@
+# flightrecorderapisqlite
+
+The [FlightRecorderDb](https://github.com/davewalker5/FlightRecorderDb) and [FlightRecorder.Api](https://github.com/davewalker5/FlightRecorder.Api) GitHub projects implement the entities, business logic and a REST service for a SQL-based aircraft sightings logbook, providing facilities for recording and querying the following data:
+
+- Manufacturer, model and aircraft registration details
+- Airline and flight details
+- Sighting locations
+- Aircraft sightings
+
+The flightrecorderapisqlite image contains a build of the logic and REST service for a SQLite database.
+
+## Getting Started
+
+### Prerequisities
+
+In order to run this image you'll need docker installed.
+
+- [Windows](https://docs.docker.com/windows/started)
+- [OS X](https://docs.docker.com/mac/started/)
+- [Linux](https://docs.docker.com/linux/started/)
+
+### Usage
+
+#### Container Parameters
+
+The following "docker run" parameters are recommended when running the flightrecorderapisqlite image:
+
+| Parameter | Value                                      | Purpose                                                 |
+| --------- | ------------------------------------------ | ------------------------------------------------------- |
+| -d        | -                                          | Run as a background process                             |
+| -v        | /local:/var/opt/flightrecorder.api-1.0.0.0 | Mount the host folder containing the SQLite database    |
+| -p        | 5001:80                                    | Expose the container's port 80 as port 5001 on the host |
+| --rm      | -                                          | Remove the container automatically when it stops        |
+
+For example:
+
+```shell
+docker run -d -v  /local:/var/opt/flightrecorder.api-1.0.0.0 -p 5001:80 --rm  davewalker5/flightrecorderapisqlite:latest
+```
+
+The "/local" path given to the -v argument is described, below, and should be replaced with a value appropriate for the host running the container. Similarly, the port number "5001" can be replaced with any available port on the host.
+
+#### Volumes
+
+The description of the container parameters, above, specifies that a folder containing the SQLite database file for the Flight Recorder database is mounted in the running container, using the "-v" parameter.
+
+That folder should contain a SQLite database that has been created using the instructions in the [Flight Recorder wiki](https://github.com/davewalker5/FlightRecorderDb/wiki).
+
+Specifically, the following should be done:
+
+- [Create the SQLite database](https://github.com/davewalker5/FlightRecorderDb/wiki/Using-a-SQLite-Database)
+- [Add a user to the database](https://github.com/davewalker5/FlightRecorderDb/wiki/REST-API)
+
+The folder containing the "flightrecorder.db" file can then be passed to the "docker run" command using the "-v" parameter.
+
+#### Running the Image
+
+To run the image, enter the following command, substituting "/local" for the host folder containing the SQLite database, as described:
+
+```shell
+docker run -d -v  /local:/var/opt/flightrecorder.api-1.0.0.0/ -p 5001:80 --rm  davewalker5/flightrecorderapisqlite:latest
+```
+
+Once the container is running, browse to the following URL on the host:
+
+http://localhost:5001
+
+You should see the Swagger API documentation for the API.
+
+## Built With
+
+The flightrecorderapisqlite image was been built with the following:
+
+| Aspect         | Version                |
+| -------------- | ---------------------- |
+| .NET Core CLI  | 3.1.101                |
+| Target Runtime | linux-x64              |
+| Docker Desktop | 19.03.5, build 633a0ea |
+
+## Find Us
+
+- [FlightRecorderDb on GitHub](https://github.com/davewalker5/FlightRecorderDb)
+- [FlightRecorder.Api on GitHub](https://github.com/davewalker5/FlightRecorder.Api)
+
+## Versioning
+
+For the versions available, see the [tags on this repository](https://github.com/davewalker5/FlightRecorder.Api/tags).
+
+## Authors
+
+- **Dave Walker** - _Initial work_ - [LinkedIn](https://www.linkedin.com/in/davewalker5/)
+
+See also the list of [contributors](https://github.com/davewalker5/FlightRecorder.Api/contributors) who
+participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/davewalker5/FlightRecorder.Api/blob/master/LICENSE) file for details.

docker/ui/Dockerfile

@@ -0,0 +1,4 @@
+FROM mcr.microsoft.com/dotnet/aspnet:latest AS runtime
+COPY flightrecorder.mvc-1.6.0.0 /opt/flightrecorder.mvc-1.6.0.0
+WORKDIR /opt/flightrecorder.mvc-1.6.0.0/bin
+ENTRYPOINT [ "./FlightRecorder.Mvc" ]