diff --git a/README.md b/README.md index 7156b19..eb244ea 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,29 @@ # flight-screen-info Will end up being a little flask site that provides the departure schedule of whatever airport you choose (like they do in real airports) -# API : +## API : This program uses the API of Flightaware. Said API requires an API key. More info [here](https://www.flightaware.com/commercial/aeroapi) -# Config.py : +## config.py : The example file needs to be copied as config.py. There, you can configure the API key and airport that interests you. -# datapull.py : +## datapull.py : This file will pull the data from flightaware's server and print it on the terminal -# Flask : +## Flask : +This is where the web app runs. + To start flask, ``flask run`` -You can then go on ``https://127.0.0.1:5000`` \ No newline at end of file +You can then go on ``https://127.0.0.1:5000`` + +# Developers : +For the CSS, tailwind is used. +To install the CSS bundler : +``` +npm install -D tailwindcss +``` +to update CSS files : +``` +npx tailwindcss -i ./static/input.css -o ./static/style.css +``` \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..8e0d1d6 --- /dev/null +++ b/package.json @@ -0,0 +1,5 @@ +{ + "devDependencies": { + "tailwindcss": "^3.4.1" + } +} diff --git a/static/input.css b/static/input.css new file mode 100644 index 0000000..e69de29 diff --git a/tailwind.config.js b/tailwind.config.js new file mode 100644 index 0000000..cbcf17c --- /dev/null +++ b/tailwind.config.js @@ -0,0 +1,11 @@ +/** @type {import('tailwindcss').Config} */ +module.exports = { + content: [ + '*/templates/**/*.html' + ], + theme: { + extend: {}, + }, + plugins: [], +} +