From 30c5e2922fe2c8247677ec588b93fbd9db566e37 Mon Sep 17 00:00:00 2001 From: John Washam Date: Mon, 17 Oct 2016 09:41:13 -0700 Subject: [PATCH 1/3] Added credit for Tinpee. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 1def820..a49abe4 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ It uses: ## How to run it +*Provided by [@Tinpee](https://github.com/tinpee) - tinpee.dev@gmail.com* + 1. Clone project to a directory on your web server. 1. Edit the config.txt file. The username and password will be the login for your site. There is only one user - you. From 9a9ac0380f35eca4184558645c9d7f317935939e Mon Sep 17 00:00:00 2001 From: John Washam Date: Tue, 18 Oct 2016 10:31:05 -0700 Subject: [PATCH 2/3] Fix and clarifications on README. --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a49abe4..044a95f 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,10 @@ It uses: --- -## How to run it - -*Provided by [@Tinpee](https://github.com/tinpee) - tinpee.dev@gmail.com* +## How to run it on a server 1. Clone project to a directory on your web server. -1. Edit the config.txt file. The username and password will be the login +1. Edit the config.txt file. Change the secret key, username and password. The username and password will be the login for your site. There is only one user - you. 1. Follow this long tutorial to get Flask running. It was way more work than it should be: https://www.digitalocean.com/community/tutorials/how-to-serve-flask-applications-with-uwsgi-and-nginx-on-ubuntu-16-04 @@ -55,10 +53,16 @@ It uses: in the top menu. ## How to run with Docker + +*Provided by [@Tinpee](https://github.com/tinpee) - tinpee.dev@gmail.com* + __Make sure you already installed [docker](https://www.docker.com)__ -- Clone project to any where you want and go to source folder -- Build image: `docker build . -t cs-flash-cards` -- Run container: `docker run -d -p 8000:8000 --name cs-flash-cards cs-flash-cards` -- Go your browser and type `http://localhost:8000` + +1. Clone project to any where you want and go to source folder. +1. Edit the config.txt file. Change the secret key, username and password. The username and password will be the login + for your site. There is only one user - you. +1. Build image: `docker build . -t cs-flash-cards` +1. Run container: `docker run -d -p 8000:8000 --name cs-flash-cards cs-flash-cards` +1. Go your browser and type `http://localhost:8000` *Happy learning!* From 35589f701645ae72f8f85062dcebc93421e7b3d9 Mon Sep 17 00:00:00 2001 From: John Washam Date: Tue, 18 Oct 2016 16:18:48 -0700 Subject: [PATCH 3/3] Added instructions on backing up card db. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 044a95f..15c003a 100644 --- a/README.md +++ b/README.md @@ -64,5 +64,6 @@ __Make sure you already installed [docker](https://www.docker.com)__ 1. Build image: `docker build . -t cs-flash-cards` 1. Run container: `docker run -d -p 8000:8000 --name cs-flash-cards cs-flash-cards` 1. Go your browser and type `http://localhost:8000` +1. To back up your cards db, run `docker cp cs-flash-cards:/src/cards.db /path/to/save` *Happy learning!*