codebuddies / backend

CodeBuddies back-end
https://codebuddies.org
GNU General Public License v3.0
20 stars 25 forks source link

[File restructuring]Django apps should be defined in project root #31

Closed brylie closed 4 years ago

brylie commented 4 years ago

Currently, this project is defining some Django apps in the cbv3_django_prototype/cbv3_django_prototype sub-directory. The project_name/project__name sub-directory is conventionally used for project-wide configuration. The Cookiecutter Django project may recommend a different file structure, but it is not apparent from a quick search of the documentation. However, running python manage.py startapp app_name in the project root creates the app in the project root, which is a fairly conventional project structure. This is a small mistake that is easy to fix.

Task

Reference

billglover commented 4 years ago

Hold until #43 is complete.

Could be completed with #30 and #50.

billglover commented 4 years ago

I'm not convinced we want to implement this. The project root contains items unrelated to Django such as the nginx configuration, the postman collection, and the docker-compose.yaml.

brylie commented 4 years ago

For clarification, the project root is where manage.py is located (currently backend/cbv3_django_prototype). The repository root is where the docker-compose.yaml is located (currently backend/).

It is conventional for Django apps to be defined in the project root. Following Django conventions makes our codebase easier to approach by new users, particularly when they are familiar with Django conventions.

billglover commented 4 years ago

Awesome, understood. This makes a lot of sense.

billglover commented 4 years ago

This looks like it was closed with c6dd158.