summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJules <jules@asdf.us>2017-12-26 04:10:43 -0500
committerJules <jules@asdf.us>2017-12-26 04:10:43 -0500
commit64cd23dbfc702ea67858d90605792a16ae038852 (patch)
tree82d032d32a2b306db46e180af4b2bb6bfb029a03
parent0ef7a5e0dc1a156a20ca75c8d75f0a26e814b02d (diff)
readme
-rw-r--r--README24
-rw-r--r--sample-env11
2 files changed, 33 insertions, 2 deletions
diff --git a/README b/README
index 0b618a9..1192253 100644
--- a/README
+++ b/README
@@ -1,2 +1,22 @@
-luckyplop
-=========
+# plop
+
+Standalone drag-and-drop image upload website.
+
+## Installation
+
+Create a MySQL database and user for this project.
+
+```
+npm install
+./node_modules/.bin/knex migrate:latest
+pm2 start index.js --name plop
+```
+
+## Building the javascript
+
+```
+grunt
+```
+
+The app.min.js file should already be in git for convenience.
+
diff --git a/sample-env b/sample-env
new file mode 100644
index 0000000..cec1968
--- /dev/null
+++ b/sample-env
@@ -0,0 +1,11 @@
+DB_HOST=localhost
+DB_NAME=plop
+DB_USER=plop
+DB_PASS=
+HOST_NAME=lvh.me
+PORT=5000
+S3_KEY=
+S3_SECRET=
+S3_BUCKET=
+S3_DIR=/p/
+