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
[The MIT License](https://github.com/HDI-Project/MTV/blob/master/LICENSE)
22
-
23
-
## Before You Begin
24
-
25
-
Before you begin we recommend you read about the basic building blocks that assemble the **MTV**:
26
25
27
26
## Prerequisites
28
27
29
28
Make sure you have installed all of the following prerequisites on your development machine:
30
29
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. To this end, [Anaconda python](https://www.anaconda.com/distribution/#download-section) is suggested to maintain the virtual environments.
30
+
-**Python (>=3.0)** - Sintel 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.
32
31
-**Git** - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
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.
34
32
-**MongoDB (>= 3.6)** - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017).
35
33
36
34
## Get Started
37
35
38
-
### Downloading MTV
39
-
40
-
##### Cloning from Github
41
-
42
-
The recommended way to get MTV is to use git to directly clone the MTV repository:
43
-
44
-
```bash
45
-
$ git clone https://github.com/HDI-Project/MTV mtv
46
-
```
47
-
48
-
This will clone the latest version of the MTV repository to a **mtv** folder.
49
-
50
-
##### Downloading the zip file
51
-
52
-
Another way to use the MTV is to download a zip copy from the [master branch on GitHub](https://github.com/HDI-Project/MTV/archive/master.zip). You can also do this using the `wget` command:
Don't forget to rename **mtv-master** after your project name.
61
36
62
37
### Quick Install
63
38
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
39
+
Once you've downloaded the Sintel 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
65
40
66
41
```bash
67
42
$ make install
68
43
```
69
44
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
45
+
This command will install all the dependencies needed for the application to run. For development, use the following command instead, which will install some additional
71
46
dependencies for code linting and testing
72
47
73
48
```bash
@@ -76,50 +51,36 @@ $ make install-develop
76
51
77
52
### Running Your Application
78
53
79
-
Please activate your virtualenv for MTV first, and then launch the server and the client:
80
-
81
-
```bash
82
-
$ mtv run -v
83
-
```
84
-
85
-
Then launch the client:
54
+
Please activate your virtualenv, and then launch the API server:
86
55
87
56
```bash
88
-
$ npm -C client run serve
57
+
$ sintel run -v
89
58
```
90
59
91
-
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).
60
+
Go to the API playground ([http://localhost:3000/apidocs](http://localhost:3000/apidocs)) to have a try.
92
61
93
62
### Development
94
63
95
-
The server-end code and client-end code are in two separate folders, namely,`<project-home>/mtv` and `<project-home>/client`
96
-
97
-
Run the following command for server-end development
98
-
99
-
```bash
100
-
$ mtv run -E development -v
101
-
```
102
-
103
-
Run the following command for client-end development
64
+
Run the following command for the purpose of development
104
65
105
66
```bash
106
-
$ npm -C client start
67
+
$ sintel run -E development -v
107
68
```
108
69
109
70
### Data
110
71
111
-
The command `make install` or `make install-develop` has already pull the demo dataset and restore it into MongoDB. The database name by default is `mtv`.
72
+
The command `make install` or `make install-develop` has already pull the demo dataset and restore it into MongoDB. The database name by default is `sintel`.
112
73
113
74
##### Working with [Orion](https://github.com/D3-AI/Orion) to generate your own data
114
75
115
-
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`.
76
+
You can type the following command to update the data from Orion to Sintel-supported formats. Note that you can configure the mongodb in the file `./sintel/config.yaml`.
116
77
117
78
```bash
118
79
$ mtv update db -v
119
80
```
120
81
121
82
122
-
## Production deploy with Docker
83
+
## Use Docker to deploy
123
84
124
85
- Install [Docker](https://docs.docker.com/install/) and [Compose](https://docs.docker.com/compose/install/)
125
86
@@ -133,38 +94,4 @@ $ mtv update db -v
133
94
$ make docker-up
134
95
```
135
96
136
-
The application should be successfully running on **port 4200** using the **production** environment by default. Just go to [http://localhost:4200](http://localhost:4200) in your chrome browser to start your exploration.
137
-
138
-
The application should be successfully running on **port 3000** using the **production** environment by default. Just go to [http://localhost:3000](http://localhost:3000) in your chrome browser to start your exploration.
139
-
140
-
For further commands, please refer to `Makefile`, the session of Docker Installation.
141
-
142
-
## Production deploy with Docker in local secure environment
143
-
144
-
- Download `mtv.zip`, unzip it, and enter the directory. The directory contains the source code of mtv; under the home directory, there is one file named `mtv.tar` which is the exported docker container's filesystem for mtv. Also, the MongoDB data is also ready under the folder `<project-home>/db-instance/data/`
145
-
146
-
- Under the project home directory, install the mtv docker images:
147
-
148
-
```bash
149
-
$ docker load --input mtv.tar
150
-
```
151
-
152
-
- Then restore data back to database:
153
-
154
-
```bash
155
-
$ docker-compose -f docker-compose-db.yml up
156
-
```
157
-
158
-
- Finally start the application:
159
-
```bash
160
-
$ docker-compose up --no-build -d
161
-
```
162
-
163
-
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 to start your exploration.
164
-
165
-
## Additional Resources
166
-
167
-
- [Install python Mac OS](https://www.python.org/downloads/mac-osx/)
Go to the API playground ([http://localhost:3000/apidocs](http://localhost:3000/apidocs)) to have a try. For further commands, please refer to `Makefile`, the session of Docker Installation.
0 commit comments