IDE_setup.md 2.26 KB
Newer Older
1
# IDE setup
Florent Chehab's avatar
Florent Chehab committed
2

3
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**).
Florent Chehab's avatar
Florent Chehab committed
4
5
6
7
8

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.

9
!> 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).
Florent Chehab's avatar
Florent Chehab committed
10

11
12
!> 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
13
14
15
16
17
18
## 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:

19
20
- 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.
Florent Chehab's avatar
Florent Chehab committed
21
22
23
24
25
26
27
28
29
30
31

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:

32
33
- Need to install `Node.js` on your system and `yarn` (`npm install -g yarn`)
- 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 `yarn install`.
Florent Chehab's avatar
Florent Chehab committed
34
35
36
37

## For general purposes

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