From b20d78799416ece6e2ea2bc7d582b5f261c675ba Mon Sep 17 00:00:00 2001 From: Sergey Sokolov Date: Sat, 9 Mar 2019 16:28:17 +0300 Subject: [PATCH] Add dockerized setup manual to readme --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b47a60b..b8b761e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,28 @@ -# postpost [![Build Status](https://travis-ci.com/PiterPy-Meetup/postpost.svg?branch=master)](https://travis-ci.com/PiterPy-Meetup/postpost) +# postpost [![Build Status](https://travis-ci.com/piterpy-meetup/postpost.svg?branch=master)](https://travis-ci.com/piterpy-meetup/postpost) -metameta. Service for posting to social media +metameta -## Required -python3.6, redis +Service for posting to various social medias from one place ## Quick Start + +### Docker-based setup +Prerequisites: docker-compose, `.env` file in the project root + +Start containers: + +`docker-compose up -d` + +Create superuser: + +`docker-compose exec api pipenv run python postpost/manage.py createsuperuser` + +### Without Docker +Prerequisites: Python 3.6, `.env` file in the project root, Redis running on port `6379` and PostgreSQL on port `5432` + `pipenv install` -`export PYTHONPATH=/full/path/postpost` +`export PYTHONPATH=/full/path/to/postpost` `export DJANGO_SETTINGS_MODULE=main.settings` @@ -22,6 +36,8 @@ Add basic user `python manage.py createsuperuser` +### Usage + Login to [admin interface](http://localhost:8000/admin/oauth2_provider/application/) and create OAuth Application with these params: