A skeleton of a Django+bootstrap+Vagrant+Ansible combo.
- Vagrant >= 1.7
- Ansible >= 2.0, < 2.1
- VirtualBox
OS :
- Ubuntu 16.04 LTS (Xenial Xerus)
Languages :
- Python 2.7
Components :
- Nginx HTTP server
- Supervisord
- Gunicorn WSGI server
- Django
- SQLite
- Bootstrap 3
Start by cloning this repository somewhere on your computer, let's say in a new folder called myproject, and go into it.
$ git clone https://github.com/numericube/ansible-django-bootstrap.git myproject/
$ cd myproject/
From there, we're gonna make this project your own by deleting the reference to this git repository and by creating a new repository from scratch :
$ rm -rf .git
$ git init
In order to provision the virtual machine, you must have Ansible installed in your host. Check the Ansible documentation to know how to install it depending on your operating system.
Now all you have to do is starting the vagrant and let the provision setup everything.
$ vagrant up
If the provisioning went well, you can access the Django website using http://localhost:8080 or https://localhost:8090 for the secure version.
In order to work inside the vagrant, you should open an SSH connexion with it.
$ vagrant ssh
You'll now be greeted with a terminal logged in as the vagrant user. As the commands shown below assume that you're logged on as the www user, you can change the user thanks to the sudo command :
$ sudo su - www
By default, Django is already running trough Gunicorn as it would run in a production environment. (Note that the default settings aren't ready for production despite that)
If you wish to run Django in a developement mode using runserver, you must beforhand shutdown the Gunicorn and Nginx servers :
$ sudo supervisorctl stop django
$ sudo service nginx stop
Then you can go to your Django project directory and run it over the 8000 HTTP port.
$ cd /vagrant/{ project name }/
$ python manage.py runserver 0.0.0.0:8000
Your Django website will be available at the http://localhost:8000 address.
The Grunt task runner bundled with Bootstrap can build the source files as soon as you edit them.
You just have to navigate to the Bootstrap directory and launch the watch :
$ cd /vagrant/{ project name }/assets/bootstrap-{ version }/
$ grunt watch
You could also do a one-time compilation of the library as is :
$ grunt dist
Note that the Django base template uses the non-minified version of Bootstrap by default because it's the one that's updated by grunt watch, so don't forget to do a grunt dist and use the minifed version of the Bootstrap files when you've done your work on them.
If you wish to edit some variables, components or just add your own ones right into the Bootstrap library, you can do it in the site_variables.less or the site_components.less files that are inside the assets/ folder of the Django project.
As these files have already been included into the Bootstrap core file, you don't have to do so yourself : their contents will be parsed while the Bootstrap compilation runs.
Nginx uses by default a self-signed SSL certificate to enable HTTPS and HTTP2.
You can replace them with your own certificates by putting them in the /provision/ansible/roles/nginx/files folder, and replacing the corresponding values in the /provision/ansible/roles/setup/vars/main.yml file.
If you look into the variables of the /provision/ansible/roles/setup/vars/main.yml file, you'll see a few ways to customize the provision before you build your vagrant :
www_home: Home directory of thewwwuserdjango_project: Name of the Django projectdjango_appname: Name of the default Django application inside the projectdjango_home: Root directory of the Django project, meant to be inside the shared folder of the Vagrantnginx_cert: SSL certificate for the web servernginx_key: Key for the SSL certificatebootstrap_version: Version of the Bootstrap library to download and setup
The main user is www and its home is under /opt/www.
The root repository is synced under /vagrant.