cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2024-11-23 10:04:01 +03:00
Code Issues Packages Projects Releases Wiki Activity
5,945 Commits 13 Branches 582 Tags 25 MiB
5503df039f
Commit Graph

345 Commits

Author SHA1 Message Date
Bruno Alla
cac78de485
Merge pull request #2664 from Afrowave/master 2020-08-14 08:16:22 +01:00
Jimmy Gitonga
ddcafff94f
Update docs/developing-locally-docker.rst 
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
 2020-08-14 01:01:17 +03:00
Jimmy Gitonga
59d92d9eb4
Update docs/developing-locally-docker.rst 
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
 2020-08-14 01:00:17 +03:00
Matthias Sieber
279175a344 updated docs 2020-07-27 14:14:15 -07:00
Bruno Alla
08a15337b3
Update document.rst 2020-07-25 14:39:04 +01:00
Bruno Alla
b592003f87
Fix snippet in documentation 2020-07-25 14:37:54 +01:00
Jimmy Gitonga
bd0ed76421 ADD instructions not include the security certificates in the repo. 2020-07-07 08:07:51 +03:00
Jimmy Gitonga
aacdd97c4e ADD instructions on how to set up a secure development environment. 2020-07-07 01:59:25 +03:00
Jimmy Gitonga
2ec3bdf55c
FIX the link to Let's Encrypt *Automatic HTTPS (#2661) 
The link was broken as it was pointing to a non-existent page.
 2020-07-06 07:54:32 -07:00
Jimmy Gitonga
697f5e1b6d FIX the link to Let's Encrypt *Automatic HTTPS 
The link was broken as it was pointing to a non-existent page.
 2020-07-06 17:31:56 +03:00
Bruno Alla
196167490d Merge branch 'master' into docs 
# Conflicts:
#	{{cookiecutter.project_slug}}/requirements/local.txt
 2020-06-29 21:48:17 +01:00
Bruno Alla
931e5c4267
Merge pull request #2608 from stefanitsky/websocket-docs 2020-06-22 19:55:09 +01:00
Alexandr
7ba61274ce 📝 docs updated after review 2020-06-22 21:42:39 +03:00
Bruno Alla
e095ee9f93
Merge pull request #2600 from tanoabeleyra/s3-cdn 
Allow to use a CDN with S3
 2020-06-21 15:07:35 +01:00
Andrew Chen Wang
8bdef165a8
Fixed local async command in docs 2020-06-16 23:51:21 -04:00
Tano Abeleyra
009ca15a4c Add AWS_S3_CUSTOM_DOMAIN entry to settings.rst 2020-05-28 19:16:54 -03:00
Alexandr
286363799c 📝 added websockets doc page #2506 
* Simple explanation.
* Example of usage with JS.
* Additional nGinx config example.
 2020-05-26 01:25:38 +03:00
Hannah Lazarus
3152bdaeb3 Add sphinx defaults for cookiecutter'd project 
-serve, watch + live reload for docs + code file changes
-update project makefile + make.bat
-separate _source and _build
-add packages and paths to use autodoc
-edit/add documentation with examples (both at django-cookiecutter and inside generated project)
-add formatted comments in User model for pickup by Sphinx apidoc
-serve docs from a separate docs container for docker build
 2020-04-30 13:23:24 -04:00
Bruno Alla
d86bd3280a
Merge pull request #2545 from hanhanhan/name_containers 2020-04-28 12:47:45 +01:00
Jonathan Thompson
393526bc47
Clarify the installation steps for local setup 
Added a link to Cookiecutter as a prerequisite.
Added an installation command for cookiecutter-django.
Added a command for git init.  The precommit install fails unless you have a git repo.

This should make it easier for a newcomer to get things configured.
 2020-04-27 02:31:46 +00:00
Hannah Lazarus
f9c20af456 Add container_names for docker commands 
container_names make it possible to run docker commands
without looking up container hash
use in dev.yml
 2020-04-24 16:31:20 -04:00
Bruno Alla
c4e4bea31b Merge branch 'master' into async 2020-04-16 09:43:38 +01:00
Andrew-Chen-Wang
cc099ae941 Edited docs for local running async 2020-04-13 11:26:09 -04:00
Bruno Alla
2993bbf78f
Merge pull request #2514 from codnee/python_3.8 
Upgrade to Python 3.8
 2020-04-13 15:13:32 +01:00
Andrew Chen Wang
2ecbf7ac34
Merge branch 'master' into async 2020-04-06 23:02:36 -04:00
gwiskur
68d751f2d4 Add compress command when using Django Compressor 
If the django-compressor option is selected, then the ``compress`` command is required where COMPRESS_OFFLINE = True is default in the production settings.  See here: https://django-compressor.readthedocs.io/en/latest/usage/#offline-compression
 2020-04-04 08:59:00 -05:00
Ernesto Cedeno
0cdf60ceac Change Python version to 3.8 2020-03-29 19:55:27 +02:00
Fabio C. Barrioneuvo da Luz
83f28a592c Migrate book domain to Feldroy and other small fixes 2020-03-25 11:57:33 -03:00
Andrew-Chen-Wang
aee2de347b Add uvicorn and web sockets for Django 3 
* Add use_async option to cookiecutter.json
* Add websocket configuration
 2020-03-24 15:40:14 -04:00
Andrew-Chen-Wang
484fa4ae77 Added unsupported mail_service combinations 
* Added default yaml Loader for pre_gen_projects.py
 2020-03-22 13:31:52 -04:00
Andrew-Chen-Wang
9cf72849e6 Merged parent repo and configured refurbished tests 2020-03-14 13:29:08 -04:00
Bruno Alla
48f7a4a7d2
Merge pull request #2433 from demestav/master 
Flower now served by Traefik
 2020-02-23 11:32:47 +00:00
Andrew-Chen-Wang
ac884f3f75 Updated mail service docs 
* Trying to appease the Black-linter god...
 2020-02-06 20:18:49 -05:00
Leonardo
45c353241b
Include use_drf option on documentation 2020-02-06 05:37:31 -04:00
Demetris Stavrou
25a70c5b84 Added Flower access documentation for production. 2020-02-04 22:47:56 +02:00
Bruno Alla
4bf0533bfa Fix broken links duplicated from testing.rst 2020-01-23 18:39:38 +00:00
Bruno Alla
00772d7141 Merge remote-tracking branch 'origin/master' into update-doc 2020-01-23 18:38:26 +00:00
Bruno Alla
bc00a343ea Fix broken links in doc fixes #2408 2020-01-22 10:52:31 +00:00
howiezhao
16b219034a Update docs files 2019-12-28 17:26:43 +08:00
Ivan Khomutov
113ce88d9c Add option to choose CI tool 2019-12-06 10:55:00 +03:00
Bruno Alla
d68db825e2
Add pre-commit for the generated project. (#2171) (#2295) 
Add pre-commit for the generated project. (#2171)
 2019-11-04 13:38:02 +01:00
Gilbishkosma
91c6f69a57
Update deployment-with-docker.rst 2019-11-03 19:51:56 +05:30
leollon
4a194c6966 Add pre-commit for the generated project. (#2171) 2019-10-29 22:48:39 +08:00
Nicolas Stefani
acb72cb84c Updated docs 2019-09-29 21:48:04 -03:00
Bruno Alla
dd32fb2c13 Tweak formatting in docs 2019-06-18 20:50:17 +01:00
Min ho Kim
62df724c8c Fix typo 2019-06-15 06:37:58 +10:00
Bruno Alla
d04b128e0f Typo in doc reference 2019-05-29 14:55:38 +01:00
Bruno Alla
3de1715b12 Add troubleshooting section regarding Posgres auth issues - fixes #1678 2019-05-29 14:54:18 +01:00
Bruno Alla
7e47e9c2aa
Mailgun api url (#2014) 
Mailgun api url
 2019-05-28 11:27:54 +01:00
Tano Abeleyra
9a3a796a89 Use GCP acronym for Google Cloud Platform 2019-05-27 17:39:45 -03:00
Bruno Alla
007f3ffb31 Docs update 2019-05-27 18:16:51 +01:00
Bruno Alla
2d1befe8e2 Update docs about settings 2019-05-27 18:16:00 +01:00
Bruno Alla
c245c1ab09 Update copyright year in the docs 2019-05-27 17:19:24 +01:00
Bruno Alla
92e4bdf171
Make cloud_provider optional (#2067) 
Make cloud_provider optional
 2019-05-27 15:50:18 +01:00
Demetris Stavrou
61c842cd9d
Update docs/deployment-with-docker.rst 
Co-Authored-By: Bruno Alla <browniebroke@users.noreply.github.com>
 2019-05-22 09:47:03 +03:00
Demetris Stavrou
7cc94c139c Updated documentation 2019-05-21 22:44:10 +03:00
Curtis St Pierre
4bf795a908 1989 - reworked postgres version options 2019-05-20 08:53:07 -07:00
Tano Abeleyra
de7be3652a Make cloud_provider optional 
Some projects may not need AWS or GCS
 2019-05-19 12:45:28 -03:00
Bruno Alla
3b96afc559 Deduplicate troubleshooting sections about Mailgun 2019-05-12 21:57:16 +01:00
Bruno Alla
39df72669e Merge branch 'master' into upgrade/django-2.1 
# Conflicts:
#	README.rst
 2019-04-17 08:33:54 +01:00
Bruno Alla
cd13ab4c82 Update docs/settings.rst 
Documented GOOGLE_APPLICATION_CREDENTIALS env var

Co-Authored-By: vladdoster <Dosterm@wit.edu>
 2019-04-16 11:30:22 -05:00
Bruno Alla
f6cac35b87 Update docs/project-generation-options.rst 
Clearer diction describing cloud provider roles

Co-Authored-By: vladdoster <Dosterm@wit.edu>
 2019-04-16 11:23:41 -05:00
Vlad
c041453bef Updated project-generation-options.rst to provide helpful links in case a user needs to decide between AWS s3 and GCS and added myself to contributors.rst 2019-04-14 12:07:37 -05:00
Vlad
7c8a473460 Updated settings.rst to reflect new GS env variable 2019-04-14 11:57:48 -05:00
Vlad
56aa332e01 Documented Google Cloud Storage integration as an alternative to AWS S3 2019-04-14 11:43:05 -05:00
Bruno Alla
2dcbaca3ee Update documentation 2019-04-02 19:38:23 +01:00
Bruno Alla
81851ffb6d Merge branch 'master' into mailgun_api_url 2019-04-02 15:45:37 +01:00
Bruno Alla
eacfd0e447 Merge branch 'master' into aws_s3_backup_commands 2019-04-02 15:43:56 +01:00
Jelmert
7e23327fe2 Added DJANG_AWS_S3_REGION_NAME to settings docs 2019-04-02 15:45:58 +02:00
Jelmert
27d806fab1 Typo 2019-04-02 15:36:44 +02:00
Jelmert
8851ac13ef Added the awscli container for uploading and downloading backups from and to Amazon S3 2019-04-02 15:36:44 +02:00
Jelmert
f6f2942a91 Listed MAILGUN_API_URL in settings docs 2019-04-02 15:17:22 +02:00
Bruno Alla
edf2eba6af Remove outdated warning in Local docker docs 2019-04-02 10:36:42 +01:00
Bruno Alla
6d48275e5f Fix Heroku docs 2019-04-02 10:33:38 +01:00
Bruno Alla
74ed3ab715
Merge pull request #1996 from pydanny/docs/heroku 
Docs/heroku
 2019-03-29 17:00:52 +00:00
Bruno Alla
55ef75e7a0
Merge pull request #1991 from hanaquadara/issue-1590/add-plugins-to-reqs 
Add pylint plugins to requirements.txt
 2019-03-26 21:45:51 +00:00
Bruno Alla
eb3325f767 Add documentation about Mailgun setup fixes #1705 2019-03-26 21:36:38 +00:00
Bruno Alla
9e93adaf98 Add documentation to include optional integrations fixes #449 2019-03-26 21:20:56 +00:00
Bruno Alla
b91c70d755
Add a node image to run Gulp when selecting it with Docker (#1687) 
## Description

Following up on @webyneter attempt in #1205, which is now getting outdated, I've tried to make Gulp task runner work with Docker. There is no documentation yet, but this seems to work locally with the custom bootstrap compilation...

- [x] Add a node image for local developement
- [x] Proxy the django image rather than localhost in Browser sync, pass header to keep hostname
- [x] Don't call the runserver command from Gulp, let docker-compose handle
- [x] Update package.json & gulpfile.js templates to reduce the number of unwanted empty lines
- [x] Use [multi-stage build](https://docs.docker.com/develop/develop-images/multistage-build/) in production to make sure the static assets are produced
- [x] Update documentation
- [x] Verify that the previous issue with static assets missing from production isn't there 

## Rationale

Currently, the static build isn't working nicely with Docker, extra manual setup is required.

Fixes #1762
 2019-03-25 12:10:55 +00:00
Hana Quadara
85aea55fc6 add plugins to req file; remove pylint-common 2019-03-23 00:01:23 -04:00
Guilherme Fabrizio
7d1e90bdf5 Migrate to unified Sentry SDK (#1820) 
The raven library is deprecated. Replace it by the new sentry-sdk library:

https://docs.sentry.io/error-reporting/quickstart/?platform=python

fixes #1818
 2019-03-20 10:04:44 +00:00
Demetris
b312d516a4 Replace Caddy with Traefik (#1714) 
## Description

Replace Caddy with Traefik

## Rationale

There is some trouble with the Caddy license (https://github.com/pydanny/cookiecutter-django/pull/1282#issuecomment-329617536) 

@drdaeman suggested using Traefik (https://github.com/pydanny/cookiecutter-django/pull/1282#issuecomment-353655273) which supports ACME and also plays very nice with Docker.

## Comments

I am currently using the proposed setup on a live site and it working great so far. If this PR is of interest to the maintainers, then I could commit more changes and take care of the documentation. Of course, any suggestions by the more experienced people around here, are welcome!
 2019-03-19 09:32:45 +00:00
Bruno Alla
b142713ec6 Remove running collectstatic from Heroku docs, it's done during deployments 2019-03-13 14:31:17 +00:00
yunti
1c5c4e52c0 Add automatic migrations to heroku deploys (#1951) 
heroku now has a new feature for running tasks as part of deployment. Perfect for automatic migrations.
https://devcenter.heroku.com/articles/release-phase#specifying-release-phase-tasks
 2019-03-11 21:05:31 +00:00
keithjeb
aea5c807f6 Change eager celery setting in local Docker (#1945) 
[//]: # (Thank you for helping us out: your efforts mean great deal to the project and the community as a whole!)

[//]: # (Before you proceed:)

[//]: # (1. Make sure to add yourself to `CONTRIBUTORS.rst` through this PR provided you're contributing here for the first time)
[//]: # (2. Don't forget to update the `docs/` presuming others would benefit from a concise description of whatever that you're proposing)


## Description

[//]: # (What's it you're proposing?)

Added a note around CELERY_TASK_ALWAYS_EAGER = True in docker config for local development. This causes tasks to be executed on the 'main' thread rather than by the workers. I understand why that might be desirable, but thought it worth calling out incase (like me) it makes people think something is broken.


## Rationale

[//]: # (Why does the project need that?)

Ease of use/troubleshooting


## Use case(s) / visualization(s)

[//]: # ("Better to see something once than to hear about it a thousand times.")
 2019-03-02 13:51:30 +00:00
Anuj
feebcf117f Added help for startapp 2018-12-18 17:07:35 +05:30
Gabriel Le Breton
aada594ada
Fix a typo in the documentation ✌️ 2018-12-01 03:13:15 -05:00
Fábio C. Barrionuevo da Luz
43559defad
Merge pull request #1871 from Afrowave/master 
ADDED documentation on testing when developing locally with and without Docker.
 2018-11-24 14:36:59 -03:00
Afrowave
53940411cc EDITED the developing locally doc. 2018-11-20 00:06:54 +03:00
canonnervio
197ab7f36e Modified command for Windows users (#1850) 
* Modified command for Windows users

Added comment to use double quotes for heroku pg:backups setup under Windows.

* Added name to list
 2018-11-17 09:59:38 +00:00
Bruno Alla
0de682f22d Update database setup instructions for developing locally 2018-09-29 12:30:19 +01:00
Bruno Alla
46ab5aefc7
Use a more specific version of python for venv 2018-09-16 20:04:50 +01:00
Bruno Alla
fa162dc970 Update linters page for better syntax highlighting 2018-09-15 21:26:13 +01:00
Bruno Alla
c51fd710d2 Update settings page 
- Add a few missing settings
- Remove outdated ones
- Detail behaviour with URL for databases
 2018-09-15 21:25:40 +01:00
Bruno Alla
993de2d409 Remove unused details for installing PostgreSQL, link to the official website 2018-09-15 21:24:22 +01:00
Bruno Alla
49e12332e8 Add a _static folder to silence Sphinx' warning 2018-09-15 21:23:29 +01:00
Bruno Alla
6dd64ddd53 Update documentation for bare metal local development 
- Mention the need for Redis if Celery is selected
- Link to PostgreSQL & Redis download pages
- Detail better how to set the environment
- Improve internal links using Sphinx' :ref
- Remove unused link
 2018-09-15 21:23:06 +01:00
Bruno Alla
078c1fb8ba Remove references to Compass as it's no longer required 
Also it's no longer maintained: https://github.com/Compass/compass
 2018-09-01 11:43:07 +01:00
Bruno Alla
ebcd5ec098 Cleanup outdated references to Grunt - fixes #1721 2018-08-30 20:34:56 +01:00
Diane DeMers Chen
0a858bf512 Add note about using keep_local_envs_in_vcs (#1735) 
* Add note about using keep_local_envs_in_vcs

As a newbie, I wasn't sure about `keep_local_envs_in_vcs`, so I said yes, and when CC was building, it gave me the message: 
"[INFO]: .env(s) are only utilized when Docker Compose and/or Heroku support is enabled so keeping them does not make sense given your current setup." 
Seems like it could go in this documentation, and make things easier for newbies.

* Add me to CONTRIBUTORS.RST
 2018-08-13 15:57:28 +03:00