add README.md and .env.example

README.md

@@ -0,0 +1,27 @@
+# Let's Test the Web!
+
+Test the Web enables anyone to quickly test common browser interactions on the web with mock interfaces.
+
+## Requirements
+
+- [npm](https://www.npmjs.com/) and/or [Docker](https://www.docker.com/)
+
+## Quick-start
+
+- clone the repo to your desired environment
+- build and run:
+  - with Node/npm:
+    - `npm ci && npm run build:watch`
+  - with Docker:
+    - `docker build -f Dockerfile . -t test-the-web:dev`
+    - `docker run -d -p 443:443 -p 80:80 test-the-web:dev`
+- go to `http://localhost`
+- start testing!
+
+## That, but with more options
+
+Optionally, you can change some configurations by creating a dotfile named `.env` in the `/api` directory (see `.env.example` for details). All the other usual configuration options around Node.js, Docker, [Express](https://expressjs.com/), [Docusaurus](https://docusaurus.io/), etc. apply.
+
+## SSL / Self-signed certificates
+
+The express server will attempt to find and use provided cert and key files (by default, named `ssl.crt` and `ssl.key` respectively) located in the `/api` directory. If it cannot find any, it will run the HTTP server only (still allowing for easy placement behind an SSL proxy if desired).

api/.env.example

@@ -0,0 +1,5 @@
+SSL_CERT=ssl.crt
+SSL_KEY=ssl.key
+SERVE_PORT=443
+SERVE_INSECURE_PORT=80
+STATIC_FILES_DIR=client/build