diff --git a/doc/0.getting_started.md b/doc/0.getting_started.md index e80c8dc..60fced7 100644 --- a/doc/0.getting_started.md +++ b/doc/0.getting_started.md @@ -34,21 +34,29 @@ An alternative method is available using Docker. See [2.docker.md](2.docker.md). 1. Clone the repository. 2. Install required Python modules: `pip install -r requirements.txt`. -3. Init a configuration file: `python -m flatisfy init-config > config.json`. +3. If you are running Flatisfy with Python 2, you should also `pip install + functools32`. +4. Init a configuration file: `python -m flatisfy init-config > config.json`. Edit it according to your needs (see below). -4. Build the required data files: +5. Build the required data files: `python -m flatisfy build-data --config config.json`. -5. Use it to `fetch` (and output a filtered JSON list of flats) or `import` - (into an SQLite database, for the web visualization) a list of flats - matching your criteria. -6. Install JS libraries and build the webapp: +6. You can now run `python -m flatisfy import --config config.json` to fetch + available flats, filter them and import everything in a SQLite database, + usable with the web visualization. +7. Install JS libraries and build the webapp: `npm install && npm run build:dev` (use `build:prod` in production). -7. Use `python -m flatisfy serve --config config.json` to serve the web app. +8. Use `python -m flatisfy serve --config config.json` to serve the web app. -Note: `Flatisfy` requires an up-to-date Node version. You can find +_Note_: `Flatisfy` requires an up-to-date Node version. You can find instructions on the [NodeJS website](https://nodejs.org/en/) to install latest LTS version. +_Note_: Alternatively, you can `python -m flatisfy fetch --config config.json` +to fetch available flats, filter them and output them as a filtered JSON list +(the web visualization will not be able to display them). This is mainly +useful if you plan in integrating Flatisfy in your own pipeline. + + ## Available commands