From b4b43011a559b2aed888f56b2693cb22e31c2d96 Mon Sep 17 00:00:00 2001 From: Hugo Bessa Date: Mon, 31 Jul 2023 16:55:27 -0300 Subject: [PATCH 1/3] Update django template command in README.md to include docker-compose.yml --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a272fdaf..5efb8f18 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,11 @@ This is a good starting point for modern Python/JavaScript web projects. - [ ] Open the command line and go to the directory you want to start your project in. - [ ] Start your project using: ``` - django-admin startproject theprojectname --extension py,yml,json --name Procfile,Dockerfile,README.md,.env.example,.gitignore,Makefile,render.yaml --template=https://github.com/vintasoftware/django-react-boilerplate/archive/boilerplate-release.zip + django-admin startproject theprojectname --extension py,yml,json --name Procfile,Dockerfile,docker-compose.yml,README.md,.env.example,.gitignore,Makefile,render.yaml --template=https://github.com/vintasoftware/django-react-boilerplate/archive/boilerplate-release.zip ``` Alternatively, you may start the project in the current directory by placing a `.` right after the project name, using the following command: ``` - django-admin startproject theprojectname . --extension py,yml,json --name Procfile,Dockerfile,README.md,.env.example,.gitignore,Makefile,render.yaml --template=https://github.com/vintasoftware/django-react-boilerplate/archive/boilerplate-release.zip + django-admin startproject theprojectname . --extension py,yml,json --name Procfile,Dockerfile,docker-compose.yml,README.md,.env.example,.gitignore,Makefile,render.yaml --template=https://github.com/vintasoftware/django-react-boilerplate/archive/boilerplate-release.zip ``` In the next steps, always remember to replace theprojectname with your project's name - [ ] Above: don't forget the `--extension` and `--name` params! From c6753b42542dae59a5b680e6bca756bbbc7774fb Mon Sep 17 00:00:00 2001 From: Hugo Bessa Date: Mon, 31 Jul 2023 17:23:07 -0300 Subject: [PATCH 2/3] Update docker-compose.yml --- docker-compose.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-compose.yml b/docker-compose.yml index e77e81fd..b3a70d90 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,4 +1,4 @@ -version: '3.1' +version: '3.5' services: db: From e03efb122aeb94e5bb33b73adad5ab94206bec44 Mon Sep 17 00:00:00 2001 From: Hugo Bessa Date: Thu, 3 Aug 2023 10:31:44 -0300 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9fb989a8..3172cb84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ If you made changes to this boilerplate and want to test them, do as follows: - Run `git archive -o boilerplate.zip HEAD` to create the template zip file - Run the following: ```bash - cd .. && django-admin startproject theprojectname --extension py,yml,json --name Procfile,README.md,.env.example,Dockerfile,Makefile,pyproject.toml,render.yaml --template=django-react-boilerplate/boilerplate.zip + cd .. && django-admin startproject theprojectname --extension py,yml,json --name Procfile,README.md,.env.example,Dockerfile,docker-compose.yml,Makefile,pyproject.toml,render.yaml --template=django-react-boilerplate/boilerplate.zip ``` - A new folder called `theprojectname` will be created and now you can test your changes - Make sure that the project is still running fine with and without docker