diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -4,12 +4,14 @@ My first larger project, an application using Pyhon, Flask and SQLite to downloa <h1>Installation</h1> Download a zip file containing the whole repository and store it into a folder on your PC. You should preferably use a virtual environment. -See requirements.txt for required packages. +See `requirements.txt` for required packages. <h1>Running the application</h1> -Firstly, you need to download the open data from the Ministry of Justice and build the database. Run "python justice_build.py", which will download all the source files, create an SQLite database and parse the downloaded data into the database. Note that after the downloaded data are uncompressed, they are around 13 GB and the database file has around 3.6 GB. It takes approximately 1 hour to download the data and build the database. +Firstly, you need to download the open data from the Ministry of Justice and build the database. -Once the database is built, run "python main.py" and open http://127.0.0.1:5000 You will be greeted with a search form that is described below. +Run `python justice_build.py` which will download all the source files, create an SQLite database and parse the downloaded data into the database. Note that after the downloaded data are uncompressed, they are around 13 GB and the database file has around 3.6 GB. It takes approximately 1 hour to download the data and build the database. + +Once the database is built, run `python main.py` and open `http://127.0.0.1:5000` You will be greeted with a search form that is described below. <h1>Features</h1> <h2>Search by company properties</h2> |