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

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

Closed
2 tasks
brylie opened this issue Jan 11, 2020 · 5 comments
Closed
2 tasks

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

brylie opened this issue Jan 11, 2020 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@brylie
Copy link
Member

brylie commented Jan 11, 2020

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

  • Consider reorganizing the project, so that apps are created in the project root (rather than in the nested directory)
  • Move all existing apps (namely, resources and users) to the project root

Reference

@lpatmo lpatmo self-assigned this Jan 14, 2020
@billglover billglover added the enhancement New feature or request label Jan 16, 2020
@billglover billglover added the hold label Feb 2, 2020
@billglover
Copy link
Contributor

Hold until #43 is complete.

Could be completed with #30 and #50.

@billglover
Copy link
Contributor

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.

@billglover billglover added needs discussion The fix for this issue needs discussion and removed hold labels Feb 21, 2020
@brylie
Copy link
Member Author

brylie commented Feb 21, 2020

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
Copy link
Contributor

Awesome, understood. This makes a lot of sense.

@billglover billglover removed the needs discussion The fix for this issue needs discussion label Feb 21, 2020
@BethanyG BethanyG changed the title Django apps should be defined in project root [File restructuring]Django apps should be defined in project root Mar 4, 2020
lpatmo added a commit that referenced this issue Mar 7, 2020
* Move project files like LICENSE into repository root and delete extraneous files

* Remove docs folder

* Move django apps to repository root

* Moved django apps to project root

* Issues 30 31 file reorg part 2 (#89)

* Rename project folder

* Change cbv3_django_prototype references to project

* Rename 'core' directory

* Change references to users app

* Change references to 'core' directory

* Change project name to "Codebuddies"

* Change path to /opt/codebuddies

* Fix project path

Co-authored-by: Linda Peng <[email protected]>
Co-authored-by: Brylie Christopher Oxley <[email protected]>
@billglover
Copy link
Contributor

This looks like it was closed with c6dd158.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants