diff --git a/README.md b/README.md new file mode 100644 index 0000000..3d78663 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +IGDB: Internation Glacier Database +================================== + +The IGDB is a database, that uses data from the +[WGMS](https://dx.doi.org/10.5904/wgms-fog-2019-12) to illustrate the +consequences of climate change. + +Our system allows you to visualize data with tables and plots, via our +intuitive Web UI. + +![Table](./assets/screenshots/Table.png){width = 50%} + +Technologies used +----------------- + +- Flask +- SQLAlchemy +- Pandas + +Requirements +------------ + +- Python3 +- POSIX shell +- Pip +- Pipenv +- MySQL/MariaDB + +Installation +------------ + +1. Clone the repository: + +``` bash +git clone https://coolneng.duckdns.org/gitea/coolneng/igdb +``` + +2. Change the working directory to the project: + +``` bash +cd igdb/code +``` + +3. Install the dependencies: + +``` bash +pipenv install +``` + +All the dependencies will be installed inside a virtualenv. + +Usage +----- + +1. Start a shell inside the virtualenv: + +``` bash +pipenv shell +``` + +2. Start the Flask server: + +``` bash +flask run +``` + +3. When prompted for a password, insert your MySQL/MariaDB root + password + +The database will be created and populated automatically, if needed, +each time the server is executed + +4. The website can be accessed via **localhost:5000** diff --git a/README.org b/README.org deleted file mode 100644 index c619c5e..0000000 --- a/README.org +++ /dev/null @@ -1,67 +0,0 @@ -* IGDB: Internation Glacier Database - -The IGDB is a database, that uses data from the [[https://dx.doi.org/10.5904/wgms-fog-2019-12][WGMS]] to illustrate the consequences of climate change. - -Our system allows you to visualize data with tables and plots, via our intuitive -Web UI. - - -#+CAPTION: Table -#+ATTR_HTML: :width 120 -[[./assets/screenshots/Table.png]] - -** Technologies used - -- Flask -- SQLAlchemy -- Pandas - -** Requirements - -- Python3 -- Pip -- Pipenv -- MySQL/MariaDB - -** Installation - -1. Clone the repository: - -#+BEGIN_SRC sh -git clone https://coolneng.duckdns.org/gitea/coolneng/igdb -#+END_SRC - -2. Change the working directory to the project: - -#+BEGIN_SRC sh -cd igdb -#+END_SRC - -3. Install the dependencies: - -#+BEGIN_SRC sh -pipenv install -#+END_SRC - -All the dependencies will be installed inside a virtualenv. - -** Usage - - -1. Start a shell inside the virtualenv: - -#+BEGIN_SRC sh -pipenv shell -#+END_SRC - -2. Start the Flask server: - -#+BEGIN_SRC sh -flask run -#+END_SRC - -3. When prompted for a password, insert your MySQL/MariaDB root password - -The database will be created and populated automatically, if needed, each time the server is executed - -3. The website can be accessed via *localhost:5000*