diff --git a/README.org b/README.org index 64446a9..50e9098 100644 --- a/README.org +++ b/README.org @@ -1,4 +1,64 @@ * graphPaname -This project aims to gather information about the smart city of Paris and -organize it in different plots and tables. +graphPaname is a system that collects real-time data, relevant to the COVID-19 epidemic de-escalation, from the city of Paris. + +It works with 4 datasets about the de-escalation: + +- Retailers with home delivery +- Additional parking places in relay parkings (parkings connected to public transportation) +- Temporary cycling paths +- Temporary pedestrian streets + +For each dataset, we offer a table with the data, and a map of Paris with markers. + +** Technologies + +- Flask +- Pandas +- Folium + +** Data sources + +- [[https://opendata.paris.fr/pages/home/][Open Data]] +- [[https://www.openstreetmap.org/][OpenStreetMap]] +- [[https://flickr.com][Flickr]] + +** Requirements + +- Nix + +** Installation + +1. Install Nix (compatible with Nix and Linux): + +#+BEGIN_SRC shell +curl -L https://nixos.org/nix/install | sh +#+END_SRC + +There are alternative installation methods, if you don't want to pipe curl to sh + +2. Clone the repository: + +#+BEGIN_SRC shell +git clone https://coolneng.duckdns.org/gitea/coolneng/graphPaname +#+END_SRC + +2. Change the working directory to the project: + +#+BEGIN_SRC shell +cd graphPaname +#+END_SRC + +3. Enter the nix-shell: + +#+BEGIN_SRC shell +nix-shell +#+END_SRC + +4. Run flask: + +#+BEGIN_SRC shell +flask run +#+END_SRC + +The website can be accessed via *localhost:5000*