Browse Source

improve frontend aspects of install documentation

Adrien Panay 7 years ago
parent
commit
69c0428c7f
2 changed files with 30 additions and 1 deletions
  1. 27 0
      README.md
  2. 3 1
      package.json

+ 27 - 0
README.md View File

@@ -117,6 +117,23 @@ You'll need to install the following packages on your Operating System:
117 117
 
118 118
 You also need `redis-server` package if you want to send email in async mode.
119 119
 
120
+### Frontend dependencies ###
121
+
122
+[//]: # ( from https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
123
+
124
+Install nodejs by typing:
125
+
126
+    curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -
127
+    sudo apt-get install -y nodejs
128
+
129
+Check that this went well by getting npm version:
130
+
131
+    npm -v
132
+
133
+Then install frontend dependancies:
134
+
135
+    npm install
136
+
120 137
 ## Database ##
121 138
 
122 139
 If you want use PostgreSQL as database engine:
@@ -382,6 +399,16 @@ There are other parameters which may be of some interest for you. For example, y
382 399
 * personalize home page (background image, title color...)
383 400
 * ...
384 401
 
402
+### frontend files compilation ###
403
+
404
+Considering your environment, run:
405
+
406
+    npm run gulp-dev
407
+
408
+or
409
+
410
+    npm run gulp-prod
411
+
385 412
 ### database schema ###
386 413
 
387 414
 The last step before to run the application is to initialize the database schema. This is done through the following command:

+ 3 - 1
package.json View File

@@ -4,7 +4,9 @@
4 4
   "description": "",
5 5
   "main": "",
6 6
   "scripts": {
7
-    "test": "echo \"Error: no test specified\" && exit 1"
7
+    "test": "echo \"Error: no test specified\" && exit 1",
8
+    "gulp-dev": "gulp dev",
9
+    "gulp-prod": "gulp prod"
8 10
   },
9 11
   "repository": {
10 12
     "type": "git",