IDE_setup.md 2.24 KB
Newer Older
Florent Chehab's avatar
Florent Chehab committed
1 2 3 4 5 6 7 8 9 10 11 12
IDE setup
============

The project was initially developed with VScode but can obviously be enhanced with the IDE of your choice. At the time of this writing, the use of JetBrains IDEs is highly recommended as they are really powerful IDEs (**if you are a student you can get their *ultimate* versions for free**).

In this short documentation, some configurations "issues" regarding your choice of IDE is addressed. Also, don't miss the separate documentation about the configuration of your [IDE for debugging](Technologies/debugging.md).


?> :information_desk_person: JetBrains IDEs are cranked with features and plugin which can make them a bit slow on some system. More than 75% of those plugin are completely useless for the project so you should dive into the settings and deactivate them.

!> In JetBrain IDEs you should also deactivate *auto-save* since this would cause useless recompilation of the frontend (or useless restart of the backend). Check [this link](https://intellij-support.jetbrains.com/hc/en-us/community/posts/207054215-Disabling-autosave).

13 14
!> In JetBrain IDEs **You must disable `Use "safe write"...` to make sure changes are detected and the project automatically recompiles.**

Florent Chehab's avatar
Florent Chehab committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

## For the backend

For the backend the use of [`PyCharm`](https://www.jetbrains.com/pycharm/?fromMenu) is recommended.


In this case you only need to configure the correct python interpreter:

* Open the settings (`CTRL + Alt + S`) go to `project: backend` and `Project interpreter`.
* Select `Docker` and put `registry.gitlab.utc.fr/rex-dri/rex-dri/backend:latest` for the image name.

This will give PyCharm access to the project python's dependencies.

Further configuration is required to run the project (optionally in debug mode) from the IDE. This is documented [here](Technologies/debugging.md).


## For the frontend

For the frontend the use of [`WebStorm`](https://www.jetbrains.com/webstorm/?fromMenu) is recommended.

No special configuration is required, except you might:

* Need to install `Node.js` on your system
* You should install the Node.js dependencies locally (they are in the frontend docker image, but they can't be used through the IDE this time). So run `npm ci`.


## For general purposes

`VS Code` is still a really nice general purposes IDE.