Commit Graph

66 Commits

Author SHA1 Message Date
Abe Hanoka
bca7d02f0a
Add instruction for adding a django app (#4944)
* feat(docs): add instruction for adding a django app

Following the the steps outlined in:
https://github.com/cookiecutter/cookiecutter-django/discussions/4339#discussioncomment-5922166
this PR adds a "Creating Your First Django App" section to the docs
breifly expalins the file structure and outlines the steps to add a new
app.

* Update docs/developing-locally.rst

Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>

* Update docs/developing-locally.rst

Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>

---------

Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2024-03-29 09:48:14 +00:00
Jelmer Draaijer
b488056b63 Upgrade Python to version 3.12 2024-03-18 20:07:24 +01:00
Vageeshan Mankala
73137e1764
Replace Mailhog with Mailpit (#4551)
* modifying cookiecutter.json with new config

* updated docker image and its local settings

* replacing  use_mailhog conditions

* replacing use_mailhog condition in docs

* Updating docs with mailpit
2023-09-06 20:41:01 +01:00
villancikos
1507360b1f
Added webpack tip for port 3000 instead of 8000 in developing-locally… (#4413)
* Added webpack tip for port 3000 instead of 8000 in developing-locally.rst

* Rework Webpack/Gulp documentation to be more consistent across the board

---------

Co-authored-by: Bruno Alla <alla.brunoo@gmail.com>
2023-07-10 18:35:57 +01:00
dependabot[bot]
5bc3df7650
Upgrade to node v18 (#4294)
* Bump node in /{{cookiecutter.project_slug}}/compose/local/node

Bumps node from 16-bullseye-slim to 18-bullseye-slim.

---
updated-dependencies:
- dependency-name: node
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update to node 18 in prod Dockerfile

* Update to node 18 in package.json

* Update node version in CI

* Update node version in documentation

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Bruno Alla <alla.brunoo@gmail.com>
2023-04-26 08:06:56 +01:00
Jelmer
42c30dafcb
Upgrade Python to version 3.11 (Faster CPython) (#4256)
* Upgrade Python to version 3.11 (Faster CPython)

* Update pyupgrade config for Python 3.11

* Update tox env to Python 3.11

* Update to latest Python 3.11.3

* Add a note about lack of support in PythonAnywhere

* Rephrase note

* Fix casing

---------

Co-authored-by: Bruno Alla <alla.brunoo@gmail.com>
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2023-04-15 11:42:33 +01:00
Bruno Alla
cbb0e19de7
Add Webpack support (#3623)
* Add support for Webpack as frontend pipeline

* Rename CI jobs

* Fix a couple of issues with Webpack + Docker

* Don't include Boostrap CSS from CDN with Webpack

* Rename variable

* Set publicPath in prod webpack config

* Fix removal of SASS files in post-gen hooks

* Add Webpack to readme usage section

* Run Django + Webpack dev server concurrently without Docker

* Fix async runserver command with Gulp/Webpack

* Upgrade django-webpack-loader to 1.5.0

* Pass variables required by Webpack at build time

* Upgrade django-webpack-loader to 1.7.0

* Add missing condition

* Add support for Azure Storage + Webpack

* Whitespaces

* Rename ROOT_DIR -> BASE_DIR

* Rename jobs

* Bump django-webpack-loader to latest

* Document limitation of Docker + Webpack + no Whitenoise

* Update section on custom Bootstrap compilation in generated readme
2023-01-29 12:12:12 +00:00
Pamela Fox
470eb70069
Update Celery instructions (#4061)
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2023-01-11 17:38:38 +00:00
Omer-5
ed90ead15f
Improve documentation for Getting started with Docker (#4003)
Fix https://github.com/cookiecutter/cookiecutter-django/issues/3971
2022-12-13 21:32:57 +00:00
Jelmer
4ea0e98f3f
Upgrade Python version from 3.9 to 3.10 (#3913) 2022-10-24 21:41:00 +01:00
monosans
9cf280d343
Reload uvicorn on html file change (#3866) 2022-09-23 21:28:11 +01:00
Bruno Alla
ab4a32d558
Unify compressor, gulp and custom bootstrap options (#3535) 2022-03-20 15:00:40 +00:00
Bruno Alla
bd12be3b38 Fix a typo in the docs 2022-03-19 18:37:48 +00:00
Cebrail Yılmaz
61f16e5224
Fix incorrect createdb instruction in documentation (#3606)
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2022-02-20 13:21:06 +00:00
Bruno Alla
9f359939a9
Upgrade JS dependencies and upgrade to node 16 (#3400) 2021-11-16 20:29:43 +00:00
Bruno Alla
5e99c7b54d
Fix wayback machine URL in docs
Fix #3223
2021-11-15 11:38:43 +00:00
Fábio C. Barrionuevo da Luz
3467fb8c02
Merge pull request #3363 from nthall/update-postgres-setup-link
use Wayback Machine to fix dead link for postgres user setup
2021-10-25 21:40:41 -03:00
Bruno Alla
b2d46296f0
Move repo under cookiecutter organisation (#3357) 2021-10-22 13:40:53 -07:00
Noah Hall
ea56c11028 use Wayback Machine to fix dead link for postgres user setup 2021-10-14 22:34:59 -04:00
Keith Callenberg
081711ee63
minor correction in working directory in docs 2021-08-09 16:29:09 -04:00
Grant McLean
9c3b0bcca0 revise previous patch to conform to project style for RST links 2021-06-09 15:39:35 +12:00
Grant McLean
05249e9954
Fix link format in developing-locally.rst
Link was markdown format - changed to RST.
2021-06-09 10:33:13 +12:00
Bruno Alla
9e7320ea1b Merge branch 'master' into fix_upgrade_py39
# Conflicts:
#	README.rst
#	{{cookiecutter.project_slug}}/.gitlab-ci.yml
#	{{cookiecutter.project_slug}}/compose/local/django/Dockerfile
#	{{cookiecutter.project_slug}}/compose/production/django/Dockerfile
2021-04-08 18:43:54 +01:00
PJ Hoberman
b980db9f62
Adding local celery instructions to developing-locally 2021-01-30 13:55:06 -07:00
areski
a1d551d067 Update from Python3.8 to Python3.9 2021-01-26 16:13:27 +01:00
Fabian Affolter
4b9002d7db
Fix formatting 2020-11-14 22:10:36 +01:00
Bruno Alla
b592003f87
Fix snippet in documentation 2020-07-25 14:37:54 +01:00
Andrew Chen Wang
8bdef165a8
Fixed local async command in docs 2020-06-16 23:51:21 -04: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
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
Ernesto Cedeno
0cdf60ceac Change Python version to 3.8 2020-03-29 19:55:27 +02:00
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
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
Afrowave
53940411cc EDITED the developing locally doc. 2018-11-20 00:06:54 +03: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
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
Nikita P. Shupeyko
a31f5090d1 Update the docs 2018-03-09 21:55:30 +03:00
Reggie Riser
2006605e24 A few cleanups: 1) Fixed common.py references (now called base.py), 2) Made URLs consistent in pointing to dev Django docs as well as https, (#1037) 2017-02-21 11:55:51 -08:00
kappataumu
eeae4e8978 Move e-mail backend setup info for docker to the appropriate section 2016-06-13 12:56:12 +00:00
kappataumu
bfe72d5276 Point to the docs instead of repeating everything 2016-06-13 12:32:13 +00:00
kappataumu
1e47efac8a Fix reST issues 2016-06-13 12:32:13 +00:00
Antonia Blair
b100f2a00d Tweak env vars section of docs (#611)
Thanks for the PR! 🍡
2016-06-11 20:50:25 -07:00
Audrey Roy Greenfeld
87845bd817 Temp quick fixes to improve developing-locally doc 2016-06-03 15:31:50 -07:00
shireenrao
e8b0baf36c Update developing locally docs on how to setup .env file
Even though a link to the django-environ is there, it may help to see that .env file needs to be present for it to work.
2016-05-23 22:37:47 -04:00