Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ajayyy committed May 12, 2019
1 parent 26f5b91 commit e24b33c
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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`.

0 comments on commit e24b33c

Please sign in to comment.