Configure Windy stations (#20)

Configure Windy stations

- add Windy Django app
- upgrade dependencies
- improved README.md

.env.localhost.template

@@ -4,6 +4,9 @@ ALLOWED_HOSTS=localhost
 
 STATIC_URL=/django-static/
 
+DB_URL=postgres://postgres:postgres@localhost:8016/winds
+REDIS_URL=redis://localhost:8017/0
+
 GOOGLE_CLIENT_SECRET=google-configs/google_client_secret.json
 
 FACEBOOK_REDIRECT_URI=http://localhost:8000/user/facebook/oauth2callback

.env.template

@@ -4,7 +4,7 @@ ALLOWED_HOSTS=localhost
 STATIC_URL=/django-static/
 
 DB_URL=postgres://postgres:postgres@postgres:5432/winds
-MONGODB_URL=mongodb://mongodb:27017/winds
+REDIS_URL=redis://redis-auth:6379/0
 
 GOOGLE_CLIENT_SECRET=google-configs/google_client_secret.json
 

README.md

@@ -1,7 +1,6 @@
 winds.mobi - real-time weather observations
 ===========================================
 
-[![DockerHub](https://img.shields.io/docker/cloud/automated/windsmobi/winds-mobi-admin)](https://cloud.docker.com/u/windsmobi/repository/docker/windsmobi/winds-mobi-admin)
 [![Follow us on https://www.facebook.com/WindsMobi/](https://img.shields.io/badge/facebook-follow_us-blue)](https://www.facebook.com/WindsMobi/)
 
 [winds.mobi](http://winds.mobi): Paraglider pilot, kitesurfer, check real-time weather conditions of your favorite spots
@@ -10,36 +9,57 @@ on your smartphone, your tablet or your computer.
 winds-mobi-admin
 --------------------
 
-Django application to manage winds.mobi users and profiles
+Django application to administrate winds.mobi:
 
-### Requirements
+- manage users and profiles
+- configure Zermatt stations
+- configure Windy stations
 
-- python >= 3.6
-- a database supported by [django](https://docs.djangoproject.com/en/2.2/ref/databases/) 
-- mongodb >= 3.0
+### Dependencies
 
-See [settings.py](https://github.com/winds-mobi/winds-mobi-admin/blob/master/winds_mobi_admin/settings.py)
+- python 3.9 and poetry 
+- postgres 
+- redis
 
-#### macOS
+See [settings.py](https://github.com/winds-mobi/winds-mobi-admin/blob/main/winds_mobi_admin/settings.py)
+
+### Run the project with docker compose (simple way)
+
+Create a `.env` file from `.env.template` and, optionally, fill the missing secrets for Facebook and Google social
+authentications.
+
+- `docker compose --profile=application up --build`
+
+### Run the project locally on macOS
+
+#### Install dependencies
 
 - `brew install libpq`
 - `export PATH=/usr/local/opt/libpq/bin:$PATH`
 - `export LDFLAGS="-I/usr/local/opt/openssl/include -L/usr/local/opt/openssl/lib"`
 
-### Python environment
+#### Python environment
+
+- `poetry install`
+- `poetry shell`
+
+Create a `.env.localhost` file from `.env.localhost.template` and fill the missing secrets.
+
+#### Create db schema
+
+- `dotenv -f .env.localhost run python manage.py migrate`
 
-- `pipenv install`
-- `pipenv shell`
+#### Start external services with docker compose
 
-### Create db schema
+Create a `.env` file from `.env.template`.
 
-- `python manage.py migrate`
+- `docker compose up`
 
-### Run the server
+#### Run the server
 
-- `python manage.py runserver`
+- `dotenv -f .env.localhost run python manage.py runserver 8006`
 
 Licensing
 ---------
 
-Please see the file called [LICENSE.txt](https://github.com/winds-mobi/winds-mobi-admin/blob/master/LICENSE.txt)
+Please see the file called [LICENSE.txt](https://github.com/winds-mobi/winds-mobi-admin/blob/main/LICENSE.txt)

docker-compose.yml → docker-compose.yaml

@@ -12,8 +12,8 @@ services:
     volumes:
       - ./volumes/postgres:/var/lib/postgresql/data
 
-  redis:
-      image: redis:7.0.2
+  redis-auth:
+      image: redis:7.0.4
       ports:
         - "8017:6379"
 
@@ -33,17 +33,13 @@ services:
       STATIC_URL: ${STATIC_URL}
       DB_URL: ${DB_URL}
       REDIS_URL: ${REDIS_URL}
-      MONGODB_URL: ${MONGODB_URL}
       GOOGLE_CLIENT_SECRET: ${GOOGLE_CLIENT_SECRET}
       FACEBOOK_REDIRECT_URI: ${FACEBOOK_REDIRECT_URI}
       FACEBOOK_CLIENT_ID: ${FACEBOOK_CLIENT_ID}
       FACEBOOK_CLIENT_SECRET: ${FACEBOOK_CLIENT_SECRET}
     networks:
       - default
-      - winds-mobi-providers
 
 networks:
   default:
     name: winds-mobi-admin
-  winds-mobi-providers:
-    external: true