sp-dev-fx-webparts/samples/react-flighttracker/README.md

90 lines
5.9 KiB
Markdown
Raw Normal View History

2022-12-01 04:24:35 -05:00
# Flight Tracker
2022-11-12 15:26:28 -05:00
## Summary
This WebPart allows to track all flights from a selected airport, date and information type.
2022-12-01 04:24:35 -05:00
The SPFx use external API (https://aerodatabox.p.rapidapi.com/flights/number/) to get data of flight, please see https://rapidapi.com/aedbx-aedbx/api/aerodatabox/ to get more information. There are some restrictions on this API, the number of requests is limited (free version)
2022-11-12 15:26:28 -05:00
2022-12-01 04:24:35 -05:00
![SharePoint View](./src/assets/sharepoint.png "SharePoint View")
2022-11-13 16:35:35 -05:00
![Teams View](./src/assets/teams.jpg "Teams View")
2022-11-13 17:42:44 -05:00
![properties](./src/assets/properties.png "Teams View")
2022-11-12 15:26:28 -05:00
2022-12-01 04:24:35 -05:00
## Compatibility
This sample is optimally compatible with the following environment configuration:
2022-11-12 15:26:28 -05:00
![SPFx 1.15](https://img.shields.io/badge/SPFx-1.15-green.svg)
![Node.js v14 | v12](https://img.shields.io/badge/Node.js-v14%20%7C%20v12-green.svg)
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
## Applies to
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
## Solution
Solution|Author(s)
--------|---------
2022-11-13 17:51:08 -05:00
react-flighttracker | [João Mendes](https://github.com/joaojmendes) ([@joaojmendes](https://twitter.com/joaojmendes)), StaffBase |
2022-11-12 15:26:28 -05:00
## Version history
Version|Date|Comments
-------|----|--------
2022-11-13 16:35:35 -05:00
1.0|November 11, 2022|Initial release
2022-11-12 15:26:28 -05:00
2022-11-13 16:35:35 -05:00
## Minimal Path to Awesome
2022-11-12 15:26:28 -05:00
2022-12-01 04:24:35 -05:00
* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-flighttracker) then unzip it)
* From your command line, change your current directory to the directory containing this sample (`react-flighttracker`, located under `samples`)
* in the command line run:
- `npm install`
- `gulp build --ship`
- `gulp bundle --ship`
- `gulp package-solution --ship`
* Browse to your SharePoint app catalog and load the SPFx package.
2022-11-14 06:10:07 -05:00
2022-11-12 15:26:28 -05:00
## Features
2022-11-15 09:45:16 -05:00
External API , Global State Management with Jotai Library, React Hooks , CCS-In-JS Styling
2022-11-12 15:26:28 -05:00
## References
- [Getting started with SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
- [Building for Microsoft teams](https://learn.microsoft.com/sharepoint/dev/spfx/build-for-teams-overview)
- [Use Microsoft Graph in your solution](https://learn.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis)
- [Publish SharePoint Framework applications to the Marketplace](https://learn.microsoft.com/sharepoint/dev/spfx/publish-to-marketplace-overview)
- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
- [Fluent UI version 9](https://github.com/microsoft/fluentui/tree/master/packages/react-components) - Converged Fluent UI components
## Help
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
2022-12-01 04:24:35 -05:00
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-flighttracker%22) to see if anybody else is having the same issues.
2022-11-12 15:26:28 -05:00
2022-12-01 04:24:35 -05:00
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-flighttracker) and see what the community is saying.
2022-11-12 15:26:28 -05:00
2022-12-01 04:24:35 -05:00
If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-flighttracker&template=bug-report.yml&sample=react-flighttracker&authors=@joaojmendes&title=react-flighttracker%20-%20).
2022-11-12 15:26:28 -05:00
2022-12-01 04:24:35 -05:00
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-flighttracker&template=question.yml&sample=react-flighttracker&authors=@joaojmendes&title=react-flighttracker%20-%20).
2022-11-12 15:26:28 -05:00
2022-12-01 04:24:35 -05:00
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-flighttracker&template=suggestion.yml&sample=react-flighttracker&authors=@joaojmendes&title=react-flighttracker%20-%20).
2022-11-12 15:26:28 -05:00
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
2022-12-01 04:24:35 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-flighttracker" />