You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-25Lines changed: 11 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,11 +28,10 @@ Before you begin we recommend you read about the basic building blocks that asse
28
28
29
29
## Prerequisites
30
30
Make sure you have installed all of the following prerequisites on your development machine:
31
-
-**Python (>=3.0)** - MTV has been developed and runs on [Python 3.6](https://www.python.org/downloads/release/python-360/). Although it is not strictly required, the usage of a [virtualenv](https://virtualenv.pypa.io/en/latest/) is highly recommended in order to avoid interfering with other software installed in the system where **MTV** is run.
-**Python (>=3.0)** - MTV has been developed and runs on [Python 3.6](https://www.python.org/downloads/release/python-360/). Although it is not strictly required, the usage of a [virtualenv](https://virtualenv.pypa.io/en/latest/) is highly recommended in order to avoid interfering with other software installed in the system where **MTV** is run. To this end, [Anaconda python](https://www.anaconda.com/distribution/#download-section) is suggested to maintain the virtual environments.
33
32
-**Git** - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
34
33
-**Node.js (>= 10.0.0)** - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager. Make sure to install gulp-cli globally after the installation of Node.js.
35
-
-**MongoDB** - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017).
34
+
-**MongoDB (>= 3.6)** - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017).
36
35
37
36
## Get Started
38
37
@@ -60,15 +59,12 @@ $ rm mtv.zip
60
59
61
60
Don't forget to rename **mtv-master** after your project name.
62
61
63
-
64
-
65
62
### Quick Install
66
63
67
64
Once you've downloaded the MTV repository and installed all the prerequisites, you're just a few steps away from running your application. To install the project, create a virtualenv and execute
68
65
69
66
```bash
70
67
$ make install
71
-
$ cd mtv-client && npm install
72
68
```
73
69
74
70
This command will install all the dependencies needed for the application (server-end) to run. For development, use the following command instead, which will install some additional
@@ -90,38 +86,29 @@ $ make load-db-mtv
90
86
91
87
This will download and restore the dataset into MongoDB.
92
88
93
-
##### Working with Orion to generate your own data
89
+
##### Working with [Orion](https://github.com/D3-AI/Orion) to generate your own data
94
90
95
-
Once the required data is generated using Orion, you simple type the following command to sync the data from Orion to MTV. Note that you can configure the mongodb in the file `./mtv/config.yaml`.
91
+
Once the required data is generated using Orion, you can type the following command to update the data from Orion to MTV-supported formats. Note that you can configure the mongodb in the file `./mtv/config.yaml`.
96
92
97
93
```bash
98
94
$ mtv update db -v
99
95
```
100
96
101
97
102
-
103
98
### Running Your Application
104
99
105
-
Please activate your virtualenv for MTV first, and then use the following command to run the application.
100
+
Please activate your virtualenv for MTV first, and then launch the server:
106
101
107
102
```bash
108
103
$ mtv run -v
109
104
```
110
105
111
-
Your application should run on **port 4200** with the ***production*** environment by default. Just go to [http://localhost:4200](http://localhost:4200) in your browser (Chrome).
112
-
113
-
The following list the optional arguments for `mtv run`
114
-
115
-
```
116
-
usage: mtv run [-h] [-l LOGFILE] [-v] [-P PORT] [-E ENV]
117
-
118
-
optional arguments:
119
-
-h, --help show this help message and exit
120
-
-l, --logfile LOGFILE Name of the logfile. If not given, log to stdout.
121
-
-v, --verbose Be verbose. Use -vv for increased verbosity.
122
-
-P PORT, --port PORT Flask server port
123
-
-E ENV, --env ENV Flask environment
106
+
Then launch the client:
107
+
```bash
108
+
$ cd client
109
+
$ npm start
124
110
```
111
+
Your application should run on **port 4200** with the ***production*** environment by default. Just go to [http://localhost:4200](http://localhost:4200) in your browser (Chrome recommended).
125
112
126
113
127
114
@@ -177,8 +164,7 @@ $ npm start
177
164
```
178
165
179
166
180
-
181
-
## Production deploy in local secure environment
167
+
## Production deploy with Docker in local secure environment
182
168
183
169
- Install [Docker](https://docs.docker.com/install/) and [Compose](https://docs.docker.com/compose/install/)
0 commit comments