Skip to content

Commit 38fe817

Browse files
authored
Merge pull request #288 from HDI-Project/clean
remove old client and rename mtv-client to client;
2 parents a805aba + 067c40b commit 38fe817

File tree

225 files changed

+168
-32904
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

225 files changed

+168
-32904
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ help:
3636
.PHONY: install
3737
install: clean-build clean-pyc clean-client ## install the packages for running mtv
3838
pip install -e .
39+
cd client && npm install --production
3940

4041
.PHONY: install-develop
4142
install-develop: clean-build clean-pyc clean-client ## install the package in editable mode and dependencies for development

README.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ Before you begin we recommend you read about the basic building blocks that asse
2828

2929
## Prerequisites
3030
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.
32-
- **Python pip(>=19)** - [Download & install python pip](https://pip.pypa.io/en/stable/)
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.
3332
- **Git** - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
3433
- **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).
3635

3736
## Get Started
3837

@@ -60,15 +59,12 @@ $ rm mtv.zip
6059

6160
Don't forget to rename **mtv-master** after your project name.
6261

63-
64-
6562
### Quick Install
6663

6764
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
6865

6966
```bash
7067
$ make install
71-
$ cd mtv-client && npm install
7268
```
7369

7470
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
9086

9187
This will download and restore the dataset into MongoDB.
9288

93-
##### Working with Orion to generate your own data
89+
##### Working with [Orion](https://github.com/D3-AI/Orion) to generate your own data
9490

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`.
9692

9793
```bash
9894
$ mtv update db -v
9995
```
10096

10197

102-
10398
### Running Your Application
10499

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:
106101

107102
```bash
108103
$ mtv run -v
109104
```
110105

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
124110
```
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).
125112

126113

127114

@@ -177,8 +164,7 @@ $ npm start
177164
```
178165

179166

180-
181-
## Production deploy in local secure environment
167+
## Production deploy with Docker in local secure environment
182168

183169
- Install [Docker](https://docs.docker.com/install/) and [Compose](https://docs.docker.com/compose/install/)
184170

client/.prettierrc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module.exports = {
66
tabWidth: 2,
77
overrides: [
88
{
9-
files: ['*.less', '*.css'],
9+
files: ['*.scss', '*.css'],
1010
options: {
1111
tabWidth: 4,
1212
},

client/README.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

client/assets.js

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)