From e24b33c5bcb4a9a65203bbf158006c679fd7801d Mon Sep 17 00:00:00 2001 From: Ajay Ramachandran Date: Sun, 12 May 2019 11:26:40 -0400 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 15a38bb..5e9fd00 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Summarizes scouting data into understandable words. +Has an electron app local version and a server-based remote version. + +The server-based version supports file uploading, photo uploading and `https`. They both run off the same codebase, meaning updates will work on both versions. + # Instructions Put scouting data in a folder called data (in the root directory of the program). @@ -14,4 +18,9 @@ Scouting data is generated with https://github.com/LakeEffectRobotics/LakeEffect Install the dependencies with `npm install` -Run the program with `npm start` +Run the electron app with `npm start` + +If you want to run the server based version, use `node server` +Then access the page at `http://localhost:8080` +It also supports `https`, the certificates can be placed into the `certificates` folder as `certificate.crt` and `private.key`. +The password for the data upload page should be stored in the `certificates` folder in a file called `password.txt`.