From 460357f18349dcac8c8b90c5f61f6519b5517676 Mon Sep 17 00:00:00 2001 From: Simon Fortier Date: Thu, 7 Jun 2018 10:01:33 -0400 Subject: [PATCH] Create README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..216b820 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# OD-Database + +Suggestions/concerns/PRs are welcome + +## Installation +Assuming you have Python 3 and git installed: +```bash +git clone https://github.com/simon987/od-database +cd od-database +pip3 install -r requirements.txt +``` + +## Running +```bash +python3 app.py +``` +You should be able to connect with your browser at `https://localhost:12345` + +*_Note: For now, you need to have the appropriate SSL certificates (cert.pem & privkey.pem) in /certificates. There will +be an option to disable SSL very soon_