Skip to content

Commit

Permalink
Updated the README
Browse files Browse the repository at this point in the history
  • Loading branch information
davewalker5 committed Dec 12, 2023
1 parent b3cc33e commit 1899c19
Showing 1 changed file with 27 additions and 10 deletions.
37 changes: 27 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,47 @@
# DroneFlightLog

[![Build Status](https://github.com/davewalker5/DroneFlightLogDb/workflows/.NET%20Core%20CI%20Build/badge.svg)](https://github.com/davewalker5/DroneFlightLogDb/actions)
[![GitHub issues](https://img.shields.io/github/issues/davewalker5/DroneFlightLogDb)](https://github.com/davewalker5/DroneFlightLogDb/issues)
[![Coverage Status](https://coveralls.io/repos/github/davewalker5/DroneFlightLogDb/badge.svg?branch=master)](https://coveralls.io/github/davewalker5/DroneFlightLogDb?branch=master)
[![Releases](https://img.shields.io/github/v/release/davewalker5/DroneFlightLogDb.svg?include_prereleases)](https://github.com/davewalker5/DroneFlightLogDb/releases)
[![Build Status](https://github.com/davewalker5/DroneFlightLog/workflows/.NET%20Core%20CI%20Build/badge.svg)](https://github.com/davewalker5/DroneFlightLog/actions)
[![GitHub issues](https://img.shields.io/github/issues/davewalker5/DroneFlightLog)](https://github.com/davewalker5/DroneFlightLog/issues)
[![Coverage Status](https://coveralls.io/repos/github/davewalker5/DroneFlightLog/badge.svg?branch=master)](https://coveralls.io/github/davewalker5/DroneFlightLog?branch=master)
[![Releases](https://img.shields.io/github/v/release/davewalker5/DroneFlightLog.svg?include_prereleases)](https://github.com/davewalker5/DroneFlightLog/releases)
[![NuGet](https://img.shields.io/nuget/v/DroneFlightLog.Data)](https://www.nuget.org/packages?q=droneflightlog.data)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/davewalker5/DroneFlightLogDb/blob/master/LICENSE)
[![Language](https://img.shields.io/badge/language-c%23-blue.svg)](https://github.com/davewalker5/DroneFlightLogDb/)
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/davewalker5/DroneFlightLogDb)](https://github.com/davewalker5/DroneFlightLogDb/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/davewalker5/DroneFlightLog/blob/master/LICENSE)
[![Language](https://img.shields.io/badge/language-c%23-blue.svg)](https://github.com/davewalker5/DroneFlightLog/)
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/davewalker5/DroneFlightLog)](https://github.com/davewalker5/DroneFlightLog/)

## About

DroneFlightLogDb implements the entities and business logic for a SQL-based drone flight logbook, providing facilities for recording and querying the following data:
DroneFlightLog implements a SQL-based drone flight log boook. An ASP.NET WebAPI provides access to the business logic and data access layer while an ASP.NET MVC UI provides the user interface.

The logbook allows for storage and maintenance of the following data:

- Operator details
- Drones, models and manufacturers
- Flights, flight locations and flight properties

## 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 Drone Flight Log MVC project uses the Gijgo JavaScript controls library:

- https://gijgo.com

## Getting Started

Please see the [Wiki](https://github.com/davewalker5/DroneFlightLogDb/wiki) for details on how to reference and use the Drone Flight Log business logic and how to get started with a database to hold the data.
Please see the [Wiki](https://github.com/davewalker5/DroneFlightLog/wiki) for configuration details and the user guide.

## Authors

- **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/DroneFlightLogDb/issues) page for this project on GitHub.
# To file issues or suggestions, please use the [Issues](https://github.com/davewalker5/DroneFlightLog/issues) page for this project on GitHub.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

0 comments on commit 1899c19

Please sign in to comment.