Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ omit =
pydis_site/wsgi.py
pydis_site/settings.py
pydis_site/utils/resources.py
pydis_site/apps/home/views/home.py
pydis_site/apps/home/views.py

[report]
fail_under = 100
35 changes: 35 additions & 0 deletions pydis_site/apps/home/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# The "home" app

This Django application takes care of serving the homepage of our website, that
is, the first page that you see when you open pythondiscord.com. It also
manages the timeline page showcasing the history of our community.

## Directory structure

- `migrations` is the standard Django migrations folder. As with [the API
app](../api/README.md), you usually won't need to edit this manually, use
`python manage.py makemigrations [-n short_description]` to create a new
migration here.

- `templatetags` contains custom [template tags and
filters](https://docs.djangoproject.com/en/dev/howto/custom-template-tags/)
used in the home app.

- `tests` contains unit tests that validate the home app works as expected. If
you're looking for guidance in writing tests, the [Django tutorial
introducing automated
testing](https://docs.djangoproject.com/en/dev/intro/tutorial05/) is a great
starting point.

As for the Python modules residing directly in here:

- `models.py` contains our Django model definitions for this app. As this app
is rather minimal, this is kept as a single module - more models would be
split up into a subfolder as in the other apps.

- `urls.py` configures Django's [URL
dispatcher](https://docs.djangoproject.com/en/dev/topics/http/urls/) for our
home endpoints.

- `views.py` contains our Django views. You can see where they are linked in the
URL dispatcher.
3 changes: 0 additions & 3 deletions pydis_site/apps/home/models/__init__.py

This file was deleted.

File renamed without changes.
3 changes: 0 additions & 3 deletions pydis_site/apps/home/views/__init__.py

This file was deleted.