Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ctrachte/simplifly

A single-page progressive web app to show flights for a certain origin, destination, and their prices
https://github.com/ctrachte/simplifly

Last synced: about 1 month ago
JSON representation

A single-page progressive web app to show flights for a certain origin, destination, and their prices

Host: GitHub
URL: https://github.com/ctrachte/simplifly
Owner: ctrachte
Created: 2020-12-18T14:21:36.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2021-01-14T18:07:05.000Z (almost 4 years ago)
Last Synced: 2024-05-02T14:48:29.328Z (8 months ago)
Language: JavaScript
Size: 2.16 MB
Stars: 2
Watchers: 4
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# SimpliFly
A progressive web app to show all flights on a certain date, origin and destination.

## Table of Contents

* [About the Project](#about-the-project)
* [Dependencies](#Dependencies)
* [Getting Started](#getting-started)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)

## About The Project

SimpliFly as envisioned will get flights between two destinations on a particular day and give a brief preview of the current weather in those two locations. It exists as a project for teaching async that could become more.

![Original XD mockup of interface](https://github.com/ctrachte/SimpliFly/blob/README/assets/images/interface.png?raw=true)

SimpliFly is powered by [Skyscanner](https://rapidapi.com/skyscanner/api/skyscanner-flight-search) and [National Weather Service](https://www.weather.gov/)

### Dependencies

We have a few dependencies currently:
* [Boot Strap 4](https://getbootstrap.com/)
* [Jquery](https://jquery.com/)
* [Popper](https://popper.js.org/)

## Getting Started
**If you do not plan to contribute your changes and just want to play around or view this project:**
1. Clone the repo
```sh
git clone https://github.com/ctrachte/SimpliFly
```
2. open `index.html` in your browser of choice

## Usage

This is a full web application, so in general: open `index.html`, and follow the contextual cues.

Full reactive bootstrap is implemented, but not yet optimized for smaller screens. Best experience is at full width.

## Contributing

Contributions are **greatly appreciated**!

[Please visit this contribution guide for GitHub open source if you are unsure about any of these steps:](https://gist.github.com/Chaser324/ce0505fbed06b947d962)

1. Fork the Project (top right there should be a button)
2. Look through the [issues](https://github.com/ctrachte/SimpliFly/issues), and choose one that is not in progress on the [project board](https://github.com/ctrachte/SimpliFly/projects/1)
3. Comment on the issue and I will assign it to you. *Async issues such as the API calls must be completed within our team as this is a learning project to develop skill in such things.*
4. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
5. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
6. Push to the Branch (`git push origin feature/AmazingFeature`)
7. Please track your progress on the [project board](https://github.com/ctrachte/SimpliFly/projects/1)
8. Open a Pull Request

*Code will be reviewed before being merged. If your code does not quite work or needs revision it may not be merged to main.*

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

## Contact

Caleb Trachte - *contact info will not be posted here, if you know me, message me*

Project Link: [https://github.com/ctrachte/SimpliFly/projects/1](https://github.com/ctrachte/SimpliFly/projects/1)