You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,18 +15,18 @@ The structure is inspired by [cookiecutter-django](https://github.com/pydanny/co
15
15
16
16
Few important things:
17
17
18
-
* Linux / Ubuntu is our primary OS and things are tested for that. It will mostly not work on Mac & certainly not work on Windows.
18
+
* Linux / Ubuntu is our primary OS and things are tested for that.
19
+
* It's dockerized for local development with `docker-compose`.
19
20
* It uses Postgres as the primary database.
20
-
* It comes with GitHub Actions support, [based on that article](https://hacksoft.io/github-actions-in-action-setting-up-django-and-postgres/)
21
-
* It comes with examples for writing tests with fakes & factories, based on the following articles - <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories>, <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories-advanced-usage>
22
-
* It comes with [`whitenoise`](http://whitenoise.evans.io/en/stable/) setup.
23
-
* It can be easily deployed to Heroku or AWS ECS.
24
-
* Dockerized for local development with docker-compose.
25
-
* It comes with an example list API, that uses [`django-filter`](https://django-filter.readthedocs.io/en/stable/) for filtering & pagination from DRF.
21
+
* It comes with [`whitenoise`](http://whitenoise.evans.io/en/stable/) setup, even for local development.
26
22
* It comes with [`mypy`](https://mypy.readthedocs.io/en/stable/) configured, using both <https://github.com/typeddjango/django-stubs> and <https://github.com/typeddjango/djangorestframework-stubs/>
27
23
* Basic `mypy` configuration is located in [`setup.cfg`](setup.cfg)
28
24
*`mypy` is ran as a build step in [`.github/workflows/django.yml`](.github/workflows/django.yml)
29
25
* ⚠️ The provided configuration is quite minimal. **You should figure out your team needs & configure accordingly** - <https://mypy.readthedocs.io/en/stable/config_file.html>
26
+
* It comes with GitHub Actions support, [based on that article](https://hacksoft.io/github-actions-in-action-setting-up-django-and-postgres/)
27
+
* It can be easily deployed to Heroku or AWS ECS.
28
+
* It comes with an example list API, that uses [`django-filter`](https://django-filter.readthedocs.io/en/stable/) for filtering & pagination from DRF.
29
+
* It comes with examples for writing tests with fakes & factories, based on the following articles - <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories>, <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories-advanced-usage>
0 commit comments