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

[docs] Document project structure #68

Closed
1 task
fyliu opened this issue May 30, 2024 · 0 comments
Closed
1 task

[docs] Document project structure #68

fyliu opened this issue May 30, 2024 · 0 comments

Comments

@fyliu
Copy link
Owner

fyliu commented May 30, 2024

Overview

We need to create an explanation page for the project directory structure so that new devs can understand where everything is and should go.

Action Items

  • Add a new page, something like project_structure.md and lay out and explain the project structure

Resources/Instructions

  • docs/ for documentation
  • app/ for the django application and also where the docker container's project root is
  • scripts/ to store helper scripts callable from outside docker
  • etc.

All the project files (some project-specific content omitted)

tree -L 4 -I __pycache__ -I venv -I __init__.py
├── app                                                                                                                                                                                                                                        
│   ├── core                                                                                                                                                                                                                                   
│   │   ├── admin.py                                                                                                                                                                                                                           
│   │   ├── api                                                                                                                                                                                                                       
│   │   │   ├── permissions.py                                                                                                                                                                                                                 
│   │   │   ├── serializers.py                                                                                                                                                                                                                 
│   │   │   ├── urls.py                                                                                                                                                                                                                        
│   │   │   └── views.py
│   │   ├── apps.py
│   │   ├── initial_data/
│   │   ├── migrations
│   │   │   ├── 0001_initial.py
│   │   │   ├── ...
│   │   │   └── max_migration.txt
│   │   ├── models.py
│   │   ├── scripts/
│   │   ├── tests
│   │   │   ├── conftest.py
│   │   │   ├── test_api.py
│   │   │   ├── test_models.py
│   │   │   └── test_permissions.py
│   │   └── utils
│   │       └── jwt.py
│   ├── data
│   │   └── migrations
│   │       ├── ...
│   │       └── max_migration.txt
│   ├── Dockerfile
│   ├── entrypoint.sh
│   ├── erd.png
│   ├── manage.py
│   ├── peopledepot
│   │   ├── asgi.py
│   │   ├── settings.py
│   │   ├── urls.py
│   │   └── wsgi.py
│   ├── requirements.in
│   ├── requirements.txt
│   ├── scripts
│   │   └── convert.py
│   ├── setup.cfg
│   └── tmp.md
├── CONTRIBUTING.md
├── docker-compose.yml
├── docs/
├── LICENSE
├── mkdocs.yml
├── pyproject.toml
├── README.md
└── scripts
    ├── buildrun.sh
    ├── check-migrations.sh
    ├── createsuperuser.sh
    ├── db.sh
    ├── erd.sh
    ├── lint.sh
    ├── loadenv.sh
    ├── logs.sh
    ├── migrate.sh
    ├── precommit-check.sh
    ├── run.sh
    ├── start-local.sh
    ├── test.sh
    └── update-dependencies.sh
  • scripts, docs, initial data should be documented in their own pages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant