open-plan-tool / gui

Energy Planning Application
Other
8 stars 4 forks source link

Improve project structure #198

Open 4lm opened 2 years ago

4lm commented 2 years ago

Hi @Bachibouzouk,

The project structure in this repo is different compared to most other Django projects. The problem is the unneeded app folder - which is not a python package (if it were, it would have to be registered in INSTALLED_APPS, which would make no sense). Because of this, my IDE (Pycharm) plays dumb and doesn't recognize certain imports. Therefore, I have no auto-suggestion and a lot of red underlining.

My interim solution, for now, is to open the project in the app folder so that Pycharm treats it as the project root.

The fix is easy. Put everything in the app folder in the root folder.

Now my question is, can I do the fix and put everything from app in the root of the project? What do you think?

Bachibouzouk commented 2 years ago

We can do this once the remaining PR have been merged, I guess then the docker-compose files have to be changed?

I don't want to change this before the stakeholder workshop because I don't want to spend time updating the server and fighting with possible errors, however I like the suggestion of having more standard project structure