Skip to content

Latest commit

 

History

History
104 lines (81 loc) · 3.5 KB

README.md

File metadata and controls

104 lines (81 loc) · 3.5 KB
Raw

Cookiecutter Django React Ansible

CI Build Status

cookiecutter-django-react-ansible is a cookiecutter template for setting up a Django 4.2 & React project with Ansible provisioning and some opinionated defaults.

Key Features and Technologies

  • Django 4.2
  • Python 3.11
  • React 18 using the create-react-app script
  • TypeScript
  • Ansible 9 for provisioning
  • Follows the 12-Factor methodology
  • Sets up functional tests with Selenium, Firefox and optional X11 forwarding
  • Better python dependency management with pip-tools
  • Works on Linux, macOS and Windows host environments
  • PostgreSQL 14
  • NGINX web server set up with HTTP/2 support
  • Ubuntu 22.04 (Jammy Jellyfish)
  • Certbot / Let's Encrypt SSL certificates for production, auto-generated self-signed SSL certificates for development.
  • Checks to python dependencies provided via pip-audit
  • Vagrant for the development environment
  • Comes with a Jenkinsfile for your CI / CD pipelines

Templating a Project

First, you'll need to make sure that you have cookiecutter installed:

$ pip install "cookiecutter>=1.6.0"

Next, run cookiecutter against this project:

$ git clone https://github.com/tmiller02/cookiecutter-django-react-ansible.git
$ cookiecutter cookiecutter-django-react-ansible

You'll be prompted for some values. Answer these prompts with your desired options. Once you've provided these values, your project will be generated.

project_name [My Project]: My Project
project_slug [my_project]: my_project
# if you aren't using a proxy just leave these blank
vagrant_apt_proxy []: 
vagrant_http_proxy []: 
vagrant_https_proxy []:

Enter the project and take a look around:

$ cd my_project/
$ ls

Create a git repo and push it there:

$ git init
$ git add .
$ git commit -m "Initial commit"
$ git remote add origin [email protected]:<my-git-user>/<my-git-repo>.git
$ git push -u origin master

Quickstart

To get up and running quickly, make sure you have the following requirements installed:

If using VMWare Fusion Player, make sure that you have also installed the Vagrant VMWare Utility and the vagrant-vmware-desktop plugin.

First, navigate to the project's directory:

$ cd my_project/

This project has been configured to work with either VMWare Fusion or VirtualBox as part of the Vagrant provisioning process via vagrant providers.

Provision the Vagrant dev environment:

$ vagrant up --provision

Once provisioning has finished, you can access the django app at https://localhost:4000. You can access the react app at https://localhost:5000.

Next Steps

Check out the documentation in README.md in your generated project for more detailed instructions on getting started.