aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1900d71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# File[Me]up / shady_file_upload
+
+File upload service that just about works most of the time
+
+
+## Setup
+
+- Make sure php/configuration.php is pointing to a sane database.
+- Execute INIT_DATABASE.sql on that database
+- Build the JavaScript
+
+## Building the JavaScript
+
+On Windows, just run `build.ps1'.
+
+Otherwise,
+```
+npm install # you only need to run this once
+npx tsc
+npx esbuild --bundle temp/main.js --outfile=build/bundle.js
+```