https://github.com/roaldnefs/flight-surety
Flight delay insurance Dapp with multiple smart contracts which are autonomously triggered by external sources, and which handle payments based on flight delay scenarios.
https://github.com/roaldnefs/flight-surety
Last synced: about 1 month ago
JSON representation
Flight delay insurance Dapp with multiple smart contracts which are autonomously triggered by external sources, and which handle payments based on flight delay scenarios.
- Host: GitHub
- URL: https://github.com/roaldnefs/flight-surety
- Owner: roaldnefs
- License: mit
- Created: 2021-05-08T16:56:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-13T21:22:59.000Z (over 3 years ago)
- Last Synced: 2025-02-15T01:28:31.664Z (3 months ago)
- Language: JavaScript
- Size: 1.43 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Flight Surety is a flight delay insurance Dapp with multiple smart contracts which are autonomously triggered by external sources, and which handle payments based on flight delay scenarios.
Quick Start »
Report Bug
·
Request Feature
## Introduction
Flight Surety is a flight delay insurance Dapp with multiple smart contracts which are autonomously triggered by external sources, and which handle payments based on flight delay scenarios. This repository includes:
* Multiple smart contracts written in Solidity.
* Automated contract testing using Mocha and Chai.
* ...
| ⚠️ **Notice**: For development purposes only! |
| --- |
## Prerequisites
Before running the Flight Surety project make sure the following dependencies are installed:
* Node v16.1.0
* Ganache v2.5.4
* Solidity
* Truffle v5.3.4
* Web3.js
## Getting Started
After installing all the [prerequisites](#prerequisites), the following commands can be used to setup and start the project locally:
1. Start by cloning the project using **git** (_or download and extract the [ZIP file](https://github.com/roaldnefs/flight-surety/archive/refs/heads/main.zip) from GitHub_):
```console
git clone [email protected]:roaldnefs/flight-surety.git
cd flight-surety
```
1. Install dependencies using **npm**:
```console
npm install
```
1. Setup **Metamask** and configure a local network using the following settings:
```
Network Name: Localhost 8545
RPC URL: http://localhost:8545
Chain ID: 1337
Currency Symbol: ETH
```
1. Store the **Metamask** mnemonic in the root of the project in a file called `.secret`.
1. Start **ganache-cli** in a separate terminal to run a local blockchain using the same mnemonic as **Metamask**:
```console
ganache-cli -m "$(cat .secret)" -a 50
```
The `-a` flag allows you to specify the number of accounts to generate at setup.
1. Run the test using **truffle** to verify the smart contracts are functioning as expected:
```console
truffle test --network development
```
1. If all tests are passing, the contract can be compiled and migrated using **truffle**:
```console
truffle compile
truffle migrate --network development
```
The contracts are now deployed on the local blockchain and the required configuration files and artifacts have been created automatically.
1. The front-end application (_Dapp_) can be started using the following **npm** command in a separate terminal:
```console
npm run dapp
```
1. The back-end server (_oracles and API_) can be started using the following **npm** command in a separate terminal:
```console
npm run server
```
To interact with the smart contract and Dapp open [http://localhost:8000/](http://localhost:8000/) in a browser with the **Metamask** extension installed and configured for the local blockchain.
## API
The back-end server (_oracles and API_) runs on port 3000 by default. The API contains the following endpoints:
* `/flights`: list all the registered flights.
## Resources
Resources used for developing the project:
* ...
## Acknowledgement
The project is heavily based upon [FlightSurety](https://github.com/udacity/FlightSurety), with the modified work by [Roald Nefs](https://github.com/roaldnefs) as part of the [Udacity Blockchain Developer Nanodegree Program](https://www.udacity.com/course/blockchain-developer-nanodegree--nd1309).