Skip to content

Commit aacbd44

Browse files
committed
added node modules installation to docs
1 parent 04df131 commit aacbd44

File tree

2 files changed

+43
-4
lines changed

2 files changed

+43
-4
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -328,14 +328,34 @@ git clone https://github.com/tiagofilipe12/pATLAS
328328
createdb <your_database>
329329
```
330330
5) [load the generated sql file](#database-import)
331-
6) Then execute the script `run.py`
331+
332+
6) Install frontend dependencies:
333+
334+
```
335+
# change directory to static direcoty where `index.html` will look for
336+
# its depdendenies
337+
cd pATLAS/patlas/db_manager/db_app/static/
338+
# then install them (package.json is located in this directory)
339+
yarn install
340+
```
341+
342+
7) Compile node modules so that the html can understand, using webpack:
343+
344+
```
345+
# You can also user a local installation of webpack.
346+
# entry-point.js is the config file where all the imported modules are
347+
# called
348+
node_modules/webpack/bin/webpack.js entry-point.js
349+
```
350+
351+
8) Then execute the script `run.py`
332352
```
333353
cd pATLAS/patlas/db_manager
334354
./run.py <your_database>
335355
```
336356
Note: the database name is utterly important to properly say to the
337357
frontend where to get the data.
338-
7) Go to `127.0.0.1:5000`.
358+
9) Go to `127.0.0.1:5000`.
339359

340360
### Optimization of the resources usage by the web page
341361

docs/local_installation.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,34 @@ createdb <your_database>
2727

2828
5) [load the generated sql file](https://github.com/tiagofilipe12/pATLAS#database-import)
2929

30-
6) Then execute the script `run.py`.
30+
6) Install frontend dependencies:
31+
32+
```
33+
# change directory to static direcoty where `index.html` will look for
34+
# its depdendenies
35+
cd pATLAS/patlas/db_manager/db_app/static/
36+
# then install them (package.json is located in this directory)
37+
yarn install
38+
```
39+
40+
7) Compile node modules so that the html can understand, using webpack:
41+
42+
```
43+
# You can also user a local installation of webpack.
44+
# entry-point.js is the config file where all the imported modules are
45+
# called
46+
node_modules/webpack/bin/webpack.js entry-point.js
47+
```
48+
49+
8) Then execute the script `run.py`.
3150
```
3251
cd pATLAS/patlas/db_manager
3352
./run.py <your_database>
3453
```
3554
Note: the database name is utterly important to properly say to the
3655
frontend where to get the data.
3756

38-
7) Go to `127.0.0.1:5000`.
57+
9) Go to `127.0.0.1:5000`.
3958

4059
## Optimization of the resources usage by the web page
4160

0 commit comments

Comments
 (0)