Updating README file. - linuxgaming - Linux gaming aggregate tool, built to test out NodeJS.
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
---
(DIR) commit fd75135cd60f0b36b2889e863acdd446a6b176aa
(DIR) parent 2919930fdc06bd6e6b625ce83e1bd05776d25db7
(HTM) Author: Jay Scott <me@jay.scot>
Date: Wed, 5 May 2021 20:30:36 +0100
Updating README file.
Diffstat:
A README | 29 +++++++++++++++++++++++++++++
D README.md | 66 -------------------------------
2 files changed, 29 insertions(+), 66 deletions(-)
---
(DIR) diff --git a/README b/README
@@ -0,0 +1,29 @@
+
+|> LinuxGaming
+
+This is my own Linux gaming aggregate webapp I built for personal use.
+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.
+
+
+development:
+
+ $ python3 -m virtualenv venv
+ $ source ./venv/bin/activate
+ $ pip install -r requirements.txt
+
+usage:
+
+ $ FLASK_APP=run.py FLASK_DEBUG=1 python -m flask run
+
+
+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.
+
+
+ $ docker pull mongo
+ $ docker run -p 27017:27017 -ti --rm mongo
+
+ $ mongoimport --db linuxgamingthings --collection items --drop --file ./config/test_data.json
(DIR) diff --git a/README.md b/README.md
@@ -1,66 +0,0 @@
-# LinuxGaming
-
-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
-
- - Python 3.6
- - Flask
- - MongoDB
- - AWS EBS
- - Gitlab CI
- - SemanticUI