Skip to content

Commit 3fdede8

Browse files
committed
Improve README wording / ordering
1 parent 572852d commit 3fdede8

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ The structure is inspired by [cookiecutter-django](https://github.com/pydanny/co
1515

1616
Few important things:
1717

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`.
1920
* 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.
2622
* 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/>
2723
* Basic `mypy` configuration is located in [`setup.cfg`](setup.cfg)
2824
* `mypy` is ran as a build step in [`.github/workflows/django.yml`](.github/workflows/django.yml)
2925
* ⚠️ 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>
3030

3131
## General API Stuff
3232

0 commit comments

Comments
 (0)