summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJules Laplace <julescarbon@gmail.com>2017-12-27 02:09:19 +0100
committerJules Laplace <julescarbon@gmail.com>2017-12-27 02:09:19 +0100
commitaa020bb7973dcc2b1fb9e030f45115682e8e8a83 (patch)
treef6e7ba792d5555d921b3fcd6a7015ae3c6ce30e3 /README
parenta5da14ec7c41d2007658d56d17057f83d5b1115e (diff)
parent0839d2d4e87e71a73f13d486812c056f6c6cc55f (diff)
div
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 26 insertions, 2 deletions
diff --git a/README b/README
index 0b618a9..2afd9f0 100644
--- a/README
+++ b/README
@@ -1,2 +1,26 @@
-luckyplop
-=========
+# plop
+
+Standalone drag-and-drop image upload website.
+
+## Installation
+
+Create a MySQL database and user for this project.
+
+`cp sample-env .env` and edit accordingly.
+
+Install all the modules and spin it up:
+
+```
+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.
+