adding dev info and seed data - linuxgaming - Linux gaming aggregate tool, built to test out NodeJS.
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
---
(DIR) commit 0b16335cdfd1f38d7a480e6292a00c29cc1cb986
(DIR) parent af64cef48d4d1f48cbd274daebc72365f2b4e3db
(HTM) Author: Jay Scott <me@jay.scot>
Date: Thu, 9 Aug 2018 15:38:16 +0100
adding dev info and seed data
Diffstat:
M README.md | 53 +++++++++++++++++++++++++++++--
M TODO.md | 8 +++-----
M config.py.sample | 7 +++----
3 files changed, 57 insertions(+), 11 deletions(-)
---
(DIR) diff --git a/README.md b/README.md
@@ -2,6 +2,55 @@
This is my own Linux gaming aggregate webapp I built for personal use.
+## Development
+
+### Environment
+
+Create a virtual environment in python3
+
+```bash
+python3 -m virtualenv venv
+```
+
+Load the environment
+
+```bash
+source ./venv/bin/activate
+```
+
+Install the requirements
+
+```bash
+pip install -r requirements.txt
+```
+
+Run the application in debug mode
+
+```bash
+FLASK_APP=run.py FLASK_DEBUG=1 python -m flask run
+```
+
+
+### Data import
+
+If you are using MongoDB directly installed on your local machine or else where then skip the docker commands and go straight for the the import command.
+
+Pull the latest MongoDB docker image.
+
+```bash
+docker pull mongo
+```
+Run the docker image in a throw away container.
+
+```bash
+docker run -p 27017:27017 -ti --rm mongo
+```
+Seed the data using mongo-import tool.
+
+```bash
+mongoimport --db linuxgamingthings --collection items --drop --file ./config/test_data.json
+```
+
## Tooling
@@ -9,4 +58,5 @@ This is my own Linux gaming aggregate webapp I built for personal use.
- Flask
- MongoDB
- AWS EBS
- - Gitlab CI
-\ No newline at end of file
+ - Gitlab CI
+ - SemanticUI
(DIR) diff --git a/TODO.md b/TODO.md
@@ -37,17 +37,15 @@ Steam might be the best one to do first to populate the data.
"title": search_result['title'],
"publisher": search_result['publisher'],
"category": search_result['category'],
-"url": "https://www.gog.com" + search_result['url'],
-"date": dateutil.parser.parse(release_date)
-title:
+title: "title": search_result['title'],
type: "game"
release_date:
publisher:
catagory:
gog:
- avaliable_date:
- url:
+ avaliable_date: dateutil.parser.parse(release_date)
+ url: "https://www.gog.com" + search_result['url']
steam:
avaliable_date:
url:
(DIR) diff --git a/config.py.sample b/config.py.sample
@@ -1,5 +1,5 @@
-MONGO_URI = ""
+MONGO_URI = "mongodb://127.0.0.1:27018/linuxgamingthings"
YOUTUBE_APIKEY = ""
-SECRET_KEY = ''
+SECRET_KEY = 'qwreasdj2347833huijwefnjkasdfnjkasdfnjkdfhj234hj234njknmlmdjkwkl'
TWITCH_CLIENTID = ""
-TWITCH_TOKEN = ""
-\ No newline at end of file
+TWITCH_TOKEN = ""