Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation (Development Environment section) #4082

Merged

Conversation

AmitN1212
Copy link
Contributor

@AmitN1212 AmitN1212 commented Dec 24, 2021

resolved #4072 #3844

Motivation and context

Make the installation instructions of the development environment much clearer, accurate and understandable

How has this been tested?

Checklist

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below)
# Copyright (C) 2021 Intel Corporation
#
# SPDX-License-Identifier: MIT

@AmitN1212 AmitN1212 requested a review from nmanovic as a code owner December 24, 2021 13:19
@bsekachev bsekachev added the documentation Documentation should be updated label Dec 24, 2021
@@ -73,25 +80,36 @@ description: 'Installing a development environment for different operating syste
>
> Read this article [Node Sass does not yet support your current environment](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)

- Open new terminal (Ctrl + Shift + T), run Visual Studio Code from the virtual environment
- Install [Docker Engine](https://docs.docker.com/engine/install/ubuntu/) and [Docker-Compose](https://docs.docker.com/compose/install/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or docker-desktop for Mac & Windows

Copy link
Contributor Author

@AmitN1212 AmitN1212 Dec 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ActiveChooN , But below, in Note for windows users, it says to install WSL and then follow all the commands for Ubuntu... So why would we need to install Docker for Windows?
For Mac: Maybe it is better to change the link to this.

- Reload Visual Studio Code from virtual environment
- Select `server: debug` configuration and run it (F5) to run REST server and its workers
- Make sure that ```Uncaught Exceptions``` option under breakpoints section is unchecked
- If you choose to run CVAT in localhost: Select `server: chrome` configuration and run it (F5) to open CVAT in Chrome
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is also ui.js: debug configuration with npm background task

Copy link
Contributor Author

@AmitN1212 AmitN1212 Dec 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is also ui.js: debug configuration with npm background task

@ActiveChooN , It does not work for me. Maybe I am trying to do something wrong.

Copy link
Contributor

@nmanovic nmanovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AmitN1212 , thanks for the contribution.

@nmanovic nmanovic merged commit f915385 into cvat-ai:develop Dec 31, 2021
george-kuanli-peng added a commit to myelintek/cvat that referenced this pull request Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation should be updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md guide to run debug version of CVAT
4 participants