From 593b1f6ec1108e3a9e606d112a25e4dfe07eabf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Linus=20=C3=96stberg?= Date: Tue, 16 Apr 2019 09:44:36 +0200 Subject: [PATCH] a bit of rewording --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4b34c1a05..6fb931b6d 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,13 @@ SweFreq - Swedish Frequency database Running on a production system ------------------------------ -The application is targeted at python 3.6. It will most likely work with 3.5 and 3.7 as well. +The application is targeted at python 3.6. It will most likely work with later versions as well. `venv` is not a requirement but it will help you to install the application. 1. Download the repository from [github](https://github.com/NBISweden/swefreq) -2. Credentials - - 2.1 Make sure you have registered an Elixir AAI application with the Elixir. +2. Make sure you have registered an Elixir AAI application with the Elixir. 3. Rename the file `settings_sample.json` into `settings.json` and edit all the values. @@ -23,14 +21,15 @@ The application is targeted at python 3.6. It will most likely work with 3.5 and 5. If you have `venv` and `pip` installed then you can do the following to install the required Python packages. - * backend: `backend/requirements.txt` - * importer: `scripts/importer` - * documentation: `docs/requirements.txt` - ``` source /path/to/bin/activate # activate your virtual environment pip install -r /path/to/requrements.txt # install the required Python packages - ```` + ``` + + * backend: `backend/requirements.txt` + * importer: `scripts/importer/requirements.txt` + * documentation: `docs/requirements.txt` + 6. Create the PostgreSQL database and its tables with the following command: @@ -39,8 +38,8 @@ The application is targeted at python 3.6. It will most likely work with 3.5 and psql -U postgres -h 127.0.0.1 -f sql/user_schema.sql ``` - To experience the full site you need to manually add a dataset and a user - to the database. You can use the test data in `test/data/browser_test_data.sql`. + To experience the full site you need to manually add a dataset and a user to the database. + You can use the test data in `test/data/browser_test_data.sql` as reference. 7. Add reference data and variants using the import scripts found in `scripts/`, e.g.: @@ -72,11 +71,11 @@ Quick development mode 1. Install docker (and docker-compose in case it's not included in the installation) 2. Run the server: ```bash -$ docker-compose up +docker-compose up ``` 3. Add test data to db: ```bash -$ psql -h localhost -U postgres swefreq -f test/data/browser_test_data.sql +psql -h localhost -U postgres swefreq -f test/data/browser_test_data.sql ``` [travis-badge]: https://travis-ci.org/NBISweden/swefreq.svg?branch=develop