mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2025-08-15 01:14:53 +03:00
Run prettier in the template
This commit is contained in:
parent
dba2b27131
commit
5f188c84ca
4
.github/CONTRIBUTORS-template.md
vendored
4
.github/CONTRIBUTORS-template.md
vendored
|
@ -22,8 +22,8 @@ accept and merge pull requests.
|
||||||
{%- endfor %}
|
{%- endfor %}
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
*Audrey is also the creator of Cookiecutter. Audrey and Daniel are on
|
_Audrey is also the creator of Cookiecutter. Audrey and Daniel are on
|
||||||
the Cookiecutter core team.*
|
the Cookiecutter core team._
|
||||||
|
|
||||||
## Other Contributors
|
## Other Contributors
|
||||||
|
|
||||||
|
|
32
.github/ISSUE_TEMPLATE/bug.md
vendored
32
.github/ISSUE_TEMPLATE/bug.md
vendored
|
@ -12,41 +12,47 @@ labels: bug
|
||||||
|
|
||||||
<!-- To assist you best, please include commands that you've run, options you've selected and any relevant logs -->
|
<!-- To assist you best, please include commands that you've run, options you've selected and any relevant logs -->
|
||||||
|
|
||||||
* Host system configuration:
|
- Host system configuration:
|
||||||
* Version of cookiecutter CLI (get it with `cookiecutter --version`):
|
|
||||||
* OS name and version:
|
- Version of cookiecutter CLI (get it with `cookiecutter --version`):
|
||||||
|
- OS name and version:
|
||||||
|
|
||||||
On Linux, run
|
On Linux, run
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
lsb_release -a 2> /dev/null || cat /etc/redhat-release 2> /dev/null || cat /etc/*-release 2> /dev/null || cat /etc/issue 2> /dev/null
|
lsb_release -a 2> /dev/null || cat /etc/redhat-release 2> /dev/null || cat /etc/*-release 2> /dev/null || cat /etc/issue 2> /dev/null
|
||||||
```
|
```
|
||||||
|
|
||||||
On MacOs, run
|
On MacOs, run
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sw_vers
|
sw_vers
|
||||||
```
|
```
|
||||||
|
|
||||||
On Windows, via CMD, run
|
On Windows, via CMD, run
|
||||||
|
|
||||||
```
|
```
|
||||||
systeminfo | findstr /B /C:"OS Name" /C:"OS Version"
|
systeminfo | findstr /B /C:"OS Name" /C:"OS Version"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Insert here the OS name and version
|
# Insert here the OS name and version
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
* Python version, run `python3 -V`:
|
- Python version, run `python3 -V`:
|
||||||
* Docker version (if using Docker), run `docker --version`:
|
- Docker version (if using Docker), run `docker --version`:
|
||||||
* docker-compose version (if using Docker), run `docker-compose --version`:
|
- docker-compose version (if using Docker), run `docker-compose --version`:
|
||||||
* ...
|
- ...
|
||||||
* Options selected and/or [replay file](https://cookiecutter.readthedocs.io/en/latest/advanced/replay.html):
|
|
||||||
On Linux and MacOS: `cat ${HOME}/.cookiecutter_replay/cookiecutter-django.json`
|
- Options selected and/or [replay file](https://cookiecutter.readthedocs.io/en/latest/advanced/replay.html):
|
||||||
|
On Linux and macOS: `cat ${HOME}/.cookiecutter_replay/cookiecutter-django.json`
|
||||||
(Please, take care to remove sensitive information)
|
(Please, take care to remove sensitive information)
|
||||||
```json
|
|
||||||
# Insert here the replay file content
|
```json
|
||||||
```
|
|
||||||
|
```
|
||||||
|
|
||||||
<summary>
|
<summary>
|
||||||
Logs:
|
Logs:
|
||||||
<details>
|
<details>
|
||||||
|
|
6
.github/ISSUE_TEMPLATE/paid-support.md
vendored
6
.github/ISSUE_TEMPLATE/paid-support.md
vendored
|
@ -5,8 +5,8 @@ about: Ask Core Team members to help you out
|
||||||
|
|
||||||
Provided your question goes beyond [regular support](https://github.com/cookiecutter/cookiecutter-django/issues/new?template=question.md), and/or the task at hand is of timely/high priority nature use the below information to reach out for contributors directly.
|
Provided your question goes beyond [regular support](https://github.com/cookiecutter/cookiecutter-django/issues/new?template=question.md), and/or the task at hand is of timely/high priority nature use the below information to reach out for contributors directly.
|
||||||
|
|
||||||
* Daniel Roy Greenfeld, Project Lead ([GitHub](https://github.com/pydanny), [Patreon](https://www.patreon.com/danielroygreenfeld)): expertise in Django and AWS ELB.
|
- Bruno Alla, Core Developer ([GitHub](https://github.com/sponsors/browniebroke)).
|
||||||
|
|
||||||
* Nikita Shupeyko, Core Developer ([GitHub](https://github.com/webyneter)): expertise in Python/Django, hands-on DevOps and frontend experience.
|
- Daniel Roy Greenfeld, Project Lead ([GitHub](https://github.com/pydanny), [Patreon](https://www.patreon.com/danielroygreenfeld)): expertise in Django and AWS ELB.
|
||||||
|
|
||||||
* Bruno Alla, Core Developer ([GitHub](https://github.com/sponsors/browniebroke)).
|
- Nikita Shupeyko, Core Developer ([GitHub](https://github.com/webyneter)): expertise in Python/Django, hands-on DevOps and frontend experience.
|
||||||
|
|
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
1
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -1,6 +1,5 @@
|
||||||
<!-- Thank you for helping us out: your efforts mean a great deal to the project and the community as a whole! -->
|
<!-- Thank you for helping us out: your efforts mean a great deal to the project and the community as a whole! -->
|
||||||
|
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
<!-- What's it you're proposing? -->
|
<!-- What's it you're proposing? -->
|
||||||
|
|
9
.github/changelog-template.md
vendored
9
.github/changelog-template.md
vendored
|
@ -1,8 +1,11 @@
|
||||||
{%- for change_type, pulls in grouped_pulls.items() %}
|
{%- for change_type, pulls in grouped_pulls.items() %}
|
||||||
{%- if pulls %}
|
{%- if pulls %}
|
||||||
|
|
||||||
### {{ change_type }}
|
### {{ change_type }}
|
||||||
|
|
||||||
{%- for pull_request in pulls %}
|
{%- for pull_request in pulls %}
|
||||||
|
|
||||||
- {{ pull_request.title }} ([#{{ pull_request.number }}]({{ pull_request.html_url }}))
|
- {{ pull_request.title }} ([#{{ pull_request.number }}]({{ pull_request.html_url }}))
|
||||||
{%- endfor -%}
|
{%- endfor -%}
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
{% endfor -%}
|
{% endfor -%}
|
||||||
|
|
9
.github/dependabot.yml
vendored
9
.github/dependabot.yml
vendored
|
@ -29,7 +29,8 @@ updates:
|
||||||
interval: "daily"
|
interval: "daily"
|
||||||
ignore:
|
ignore:
|
||||||
- dependency-name: "*"
|
- dependency-name: "*"
|
||||||
update-types: ["version-update:semver-major", "version-update:semver-minor"]
|
update-types:
|
||||||
|
["version-update:semver-major", "version-update:semver-minor"]
|
||||||
labels:
|
labels:
|
||||||
- "update"
|
- "update"
|
||||||
|
|
||||||
|
@ -39,7 +40,8 @@ updates:
|
||||||
interval: "daily"
|
interval: "daily"
|
||||||
ignore:
|
ignore:
|
||||||
- dependency-name: "*"
|
- dependency-name: "*"
|
||||||
update-types: ["version-update:semver-major", "version-update:semver-minor"]
|
update-types:
|
||||||
|
["version-update:semver-major", "version-update:semver-minor"]
|
||||||
labels:
|
labels:
|
||||||
- "update"
|
- "update"
|
||||||
|
|
||||||
|
@ -63,7 +65,8 @@ updates:
|
||||||
interval: "daily"
|
interval: "daily"
|
||||||
ignore:
|
ignore:
|
||||||
- dependency-name: "*"
|
- dependency-name: "*"
|
||||||
update-types: ["version-update:semver-major", "version-update:semver-minor"]
|
update-types:
|
||||||
|
["version-update:semver-major", "version-update:semver-minor"]
|
||||||
labels:
|
labels:
|
||||||
- "update"
|
- "update"
|
||||||
|
|
||||||
|
|
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
|
@ -2,7 +2,7 @@ name: CI
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [ "master", "main" ]
|
branches: ["master", "main"]
|
||||||
pull_request:
|
pull_request:
|
||||||
|
|
||||||
concurrency:
|
concurrency:
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
exclude: '{{cookiecutter.project_slug}}'
|
exclude: "{{cookiecutter.project_slug}}|.github/contributors.json|CHANGELOG.md"
|
||||||
default_stages: [commit]
|
default_stages: [commit]
|
||||||
|
|
||||||
repos:
|
repos:
|
||||||
|
@ -17,10 +17,10 @@ repos:
|
||||||
- id: detect-private-key
|
- id: detect-private-key
|
||||||
|
|
||||||
- repo: https://github.com/pre-commit/mirrors-prettier
|
- repo: https://github.com/pre-commit/mirrors-prettier
|
||||||
rev: 'v3.0.0-alpha.6'
|
rev: "v3.0.0-alpha.6"
|
||||||
hooks:
|
hooks:
|
||||||
- id: prettier
|
- id: prettier
|
||||||
args: ['--tab-width', '2']
|
args: ["--tab-width", "2"]
|
||||||
|
|
||||||
- repo: https://github.com/asottile/pyupgrade
|
- repo: https://github.com/asottile/pyupgrade
|
||||||
rev: v3.3.1
|
rev: v3.3.1
|
||||||
|
|
|
@ -76,8 +76,8 @@ accept and merge pull requests.
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
*Audrey is also the creator of Cookiecutter. Audrey and Daniel are on
|
_Audrey is also the creator of Cookiecutter. Audrey and Daniel are on
|
||||||
the Cookiecutter core team.*
|
the Cookiecutter core team._
|
||||||
|
|
||||||
## Other Contributors
|
## Other Contributors
|
||||||
|
|
||||||
|
|
13
README.md
13
README.md
|
@ -41,7 +41,7 @@ production-ready Django projects quickly.
|
||||||
|
|
||||||
## Optional Integrations
|
## Optional Integrations
|
||||||
|
|
||||||
*These features can be enabled during initial project setup.*
|
_These features can be enabled during initial project setup._
|
||||||
|
|
||||||
- Serve static files from Amazon S3, Google Cloud Storage, Azure Storage or [Whitenoise](https://whitenoise.readthedocs.io/)
|
- Serve static files from Amazon S3, Google Cloud Storage, Azure Storage or [Whitenoise](https://whitenoise.readthedocs.io/)
|
||||||
- Configuration for [Celery](https://docs.celeryq.dev) and [Flower](https://github.com/mher/flower) (the latter in Docker setup only)
|
- Configuration for [Celery](https://docs.celeryq.dev) and [Flower](https://github.com/mher/flower) (the latter in Docker setup only)
|
||||||
|
@ -63,7 +63,7 @@ This project is run by volunteers. Please support them in their efforts to maint
|
||||||
|
|
||||||
Projects that provide financial support to the maintainers:
|
Projects that provide financial support to the maintainers:
|
||||||
|
|
||||||
------------------------------------------------------------------------
|
---
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://www.feldroy.com/products//two-scoops-of-django-3-x"><img src="https://cdn.shopify.com/s/files/1/0304/6901/products/Two-Scoops-of-Django-3-Alpha-Cover_540x_26507b15-e489-470b-8a97-02773dd498d1_1080x.jpg"></a>
|
<a href="https://www.feldroy.com/products//two-scoops-of-django-3-x"><img src="https://cdn.shopify.com/s/files/1/0304/6901/products/Two-Scoops-of-Django-3-Alpha-Cover_540x_26507b15-e489-470b-8a97-02773dd498d1_1080x.jpg"></a>
|
||||||
|
@ -189,7 +189,7 @@ For local development, see the following:
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
- Have questions? **Before you ask questions anywhere else**, please post your question on [Stack Overflow](http://stackoverflow.com/questions/tagged/cookiecutter-django) under the *cookiecutter-django* tag. We check there periodically for questions.
|
- Have questions? **Before you ask questions anywhere else**, please post your question on [Stack Overflow](http://stackoverflow.com/questions/tagged/cookiecutter-django) under the _cookiecutter-django_ tag. We check there periodically for questions.
|
||||||
- If you think you found a bug or want to request a feature, please open an [issue](https://github.com/cookiecutter/cookiecutter-django/issues).
|
- If you think you found a bug or want to request a feature, please open an [issue](https://github.com/cookiecutter/cookiecutter-django/issues).
|
||||||
- For anything else, you can chat with us on [Discord](https://discord.gg/uFXweDQc5a).
|
- For anything else, you can chat with us on [Discord](https://discord.gg/uFXweDQc5a).
|
||||||
|
|
||||||
|
@ -199,13 +199,14 @@ You may notice that some elements of this project do not exactly match what we d
|
||||||
|
|
||||||
## For PyUp Users
|
## For PyUp Users
|
||||||
|
|
||||||
If you are using [PyUp](https://pyup.io) to keep your dependencies updated and secure, use the code *cookiecutter* during checkout to get 15% off every month.
|
If you are using [PyUp](https://pyup.io) to keep your dependencies updated and secure, use the code _cookiecutter_ during checkout to get 15% off every month.
|
||||||
|
|
||||||
## "Your Stuff"
|
## "Your Stuff"
|
||||||
|
|
||||||
Scattered throughout the Python and HTML of this project are places marked with "your stuff". This is where third-party libraries are to be integrated with your project.
|
Scattered throughout the Python and HTML of this project are places marked with "your stuff". This is where third-party libraries are to be integrated with your project.
|
||||||
|
|
||||||
## For MySQL users
|
## For MySQL users
|
||||||
|
|
||||||
To get full MySQL support in addition to the default Postgresql, you can use this fork of the cookiecutter-django:
|
To get full MySQL support in addition to the default Postgresql, you can use this fork of the cookiecutter-django:
|
||||||
https://github.com/mabdullahadeel/cookiecutter-django-mysql
|
https://github.com/mabdullahadeel/cookiecutter-django-mysql
|
||||||
|
|
||||||
|
@ -215,12 +216,12 @@ Need a stable release? You can find them at <https://github.com/cookiecutter/coo
|
||||||
|
|
||||||
## Not Exactly What You Want?
|
## Not Exactly What You Want?
|
||||||
|
|
||||||
This is what I want. *It might not be what you want.* Don't worry, you have options:
|
This is what I want. _It might not be what you want._ Don't worry, you have options:
|
||||||
|
|
||||||
### Fork This
|
### Fork This
|
||||||
|
|
||||||
If you have differences in your preferred setup, I encourage you to fork this to create your own version.
|
If you have differences in your preferred setup, I encourage you to fork this to create your own version.
|
||||||
Once you have your fork working, let me know and I'll add it to a '*Similar Cookiecutter Templates*' list here.
|
Once you have your fork working, let me know and I'll add it to a '_Similar Cookiecutter Templates_' list here.
|
||||||
It's up to you whether to rename your fork.
|
It's up to you whether to rename your fork.
|
||||||
|
|
||||||
If you do rename your fork, I encourage you to submit it to the following places:
|
If you do rename your fork, I encourage you to submit it to the following places:
|
||||||
|
|
|
@ -17,19 +17,8 @@
|
||||||
"windows": "n",
|
"windows": "n",
|
||||||
"use_pycharm": "n",
|
"use_pycharm": "n",
|
||||||
"use_docker": "n",
|
"use_docker": "n",
|
||||||
"postgresql_version": [
|
"postgresql_version": ["14", "13", "12", "11", "10"],
|
||||||
"14",
|
"cloud_provider": ["AWS", "GCP", "Azure", "None"],
|
||||||
"13",
|
|
||||||
"12",
|
|
||||||
"11",
|
|
||||||
"10"
|
|
||||||
],
|
|
||||||
"cloud_provider": [
|
|
||||||
"AWS",
|
|
||||||
"GCP",
|
|
||||||
"Azure",
|
|
||||||
"None"
|
|
||||||
],
|
|
||||||
"mail_service": [
|
"mail_service": [
|
||||||
"Mailgun",
|
"Mailgun",
|
||||||
"Amazon SES",
|
"Amazon SES",
|
||||||
|
@ -43,23 +32,13 @@
|
||||||
],
|
],
|
||||||
"use_async": "n",
|
"use_async": "n",
|
||||||
"use_drf": "n",
|
"use_drf": "n",
|
||||||
"frontend_pipeline": [
|
"frontend_pipeline": ["None", "Django Compressor", "Gulp", "Webpack"],
|
||||||
"None",
|
|
||||||
"Django Compressor",
|
|
||||||
"Gulp",
|
|
||||||
"Webpack"
|
|
||||||
],
|
|
||||||
"use_celery": "n",
|
"use_celery": "n",
|
||||||
"use_mailhog": "n",
|
"use_mailhog": "n",
|
||||||
"use_sentry": "n",
|
"use_sentry": "n",
|
||||||
"use_whitenoise": "n",
|
"use_whitenoise": "n",
|
||||||
"use_heroku": "n",
|
"use_heroku": "n",
|
||||||
"ci_tool": [
|
"ci_tool": ["None", "Travis", "Gitlab", "Github"],
|
||||||
"None",
|
|
||||||
"Travis",
|
|
||||||
"Gitlab",
|
|
||||||
"Github"
|
|
||||||
],
|
|
||||||
"keep_local_envs_in_vcs": "y",
|
"keep_local_envs_in_vcs": "y",
|
||||||
"debug": "n"
|
"debug": "n"
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,4 +4,3 @@ Generate a new cookiecutter-django project: ::
|
||||||
|
|
||||||
For more information refer to
|
For more information refer to
|
||||||
:ref:`Project Generation Options <template-options>`.
|
:ref:`Project Generation Options <template-options>`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user