diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea7c4a63..f6695930 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,20 +18,21 @@ Next steps should work on clear Ubuntu 18.04. $ sudo apt-get install -y curl redis-server python3-dev python3-pip python3-venv libldap2-dev libsasl2-dev ``` -- Install [Visual Studio Code](https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions) for development +- Install [Visual Studio Code](https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions) +for development -- Install CVAT on your local host: +- Install CVAT on your local host: ```sh -$ git clone https://github.com/opencv/cvat -$ cd cvat && mkdir logs keys -$ python3 -m venv .env -$ . .env/bin/activate -$ pip install -U pip wheel -$ pip install -r cvat/requirements/development.txt -$ pip install -r datumaro/requirements.txt -$ python manage.py migrate -$ python manage.py collectstatic +git clone https://github.com/opencv/cvat +cd cvat && mkdir logs keys +python3 -m venv .env +. .env/bin/activate +pip install -U pip wheel +pip install -r cvat/requirements/development.txt +pip install -r datumaro/requirements.txt +python manage.py migrate +python manage.py collectstatic ``` - Create a super user for CVAT: @@ -44,17 +45,27 @@ Password: *** Password (again): *** ``` +- Install UI packages and start UI debug server: +```sh +cd cvat-core && npm install +cd ../cvat-ui && npm install +npm run start +``` + - Run Visual Studio Code from the virtual environment -``` +```sh $ code . ``` -- Inside Visual Studio Code install [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) and [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) extensions +- Inside Visual Studio Code install [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) and [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) extensions + +- Reload Visual Studio Code -- Reload Visual Studio Code +- Select `server: debug` configuration and start it (F5) to run REST server and its workers -- Select `server: debug` configuration and start debugging (F5) +- Select `cvat-ui: chrome` configuration and start it (F5) to run UI server +(this server restarts automatically after any changes in the source code) You have done! Now it is possible to insert breakpoints and debug server and client of the tool. diff --git a/cvat-ui/.env b/cvat-ui/.env new file mode 100644 index 00000000..e69de29b diff --git a/cvat-ui/package.json b/cvat-ui/package.json index 59b3196f..d8b4944c 100644 --- a/cvat-ui/package.json +++ b/cvat-ui/package.json @@ -5,7 +5,7 @@ "main": "src/index.tsx", "scripts": { "build": "webpack --config ./webpack.config.js", - "server": "nodemon --watch config --exec 'webpack-dev-server --config ./webpack.config.js --mode=development --open'" + "server": "nodemon --watch config --exec 'webpack-dev-server --config ./webpack.config.js --mode=development'" }, "author": "Intel", "license": "MIT",