{"id":28452791,"url":"https://github.com/wagtail/vagrant-wagtail-develop","last_synced_at":"2025-06-27T23:31:15.317Z","repository":{"id":32441644,"uuid":"36019891","full_name":"wagtail/vagrant-wagtail-develop","owner":"wagtail","description":"A script to painlessly set up a Vagrant environment for development of Wagtail","archived":false,"fork":false,"pushed_at":"2024-11-04T14:57:58.000Z","size":51,"stargazers_count":37,"open_issues_count":1,"forks_count":24,"subscribers_count":27,"default_branch":"main","last_synced_at":"2025-06-27T00:25:05.217Z","etag":null,"topics":["vagrant","wagtail"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wagtail.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-05-21T15:09:40.000Z","updated_at":"2025-03-25T16:07:37.000Z","dependencies_parsed_at":"2024-11-04T15:44:06.361Z","dependency_job_id":null,"html_url":"https://github.com/wagtail/vagrant-wagtail-develop","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wagtail/vagrant-wagtail-develop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wagtail%2Fvagrant-wagtail-develop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wagtail%2Fvagrant-wagtail-develop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wagtail%2Fvagrant-wagtail-develop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wagtail%2Fvagrant-wagtail-develop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wagtail","download_url":"https://codeload.github.com/wagtail/vagrant-wagtail-develop/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wagtail%2Fvagrant-wagtail-develop/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262351445,"owners_count":23297622,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["vagrant","wagtail"],"created_at":"2025-06-06T18:12:54.592Z","updated_at":"2025-06-27T23:31:15.307Z","avatar_url":"https://github.com/wagtail.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"vagrant-wagtail-develop\n=======================\n\nA script to painlessly set up a Vagrant environment for development of Wagtail.\n\n\u003e 👋 Are you interested in a Docker-based environment? Check out [docker-wagtail-develop](https://github.com/wagtail/docker-wagtail-develop).\n\nFeatures\n--------\n* An Ubuntu 22.04 (Jammy Jellyfish) base image\n* Checkouts of Wagtail, bakerydemo, django-modelcluster and Willow ready to develop against\n* Node.js / npm toolchain for front-end asset building\n* Optional packages installed (PostgreSQL, Embedly, Sphinx...)\n* Virtualenv for Python 3.9\n\nSetup\n-----\n\n**Requirements:** [Vagrant](https://www.vagrantup.com/), and a [compatible version of VirtualBox](https://www.vagrantup.com/docs/virtualbox/).\n\nOpen a terminal and follow those instructions:\n\n```sh\n# 1. Decide where to put the project. We use \"~/Development\" in our examples.\ncd ~/Development\n# 2. Clone the vagrant-wagtail-develop repository in a new \"wagtail-dev\" folder.\ngit clone git@github.com:wagtail/vagrant-wagtail-develop.git wagtail-dev\n# 3. Move inside the new folder.\ncd wagtail-dev/\n# 4. Run the setup script. This will set up all required dependencies for you.\n./setup.sh\n```\n\n\u003e Note: On platforms that can't run shell scripts, run the commands from [`setup.sh`](setup.sh) manually instead.\n\nIt can take a while (typically 15-20 minutes) to fetch and build all dependencies - you could go for a coffee in the meantime :)\n\nHere is the resulting folder structure:\n\n```sh\n.\n├── libs          # Supporting libraries to develop Wagtail against.\n├── vagrant       # Vagrant-related files.\n├── wagtail       # Wagtail repository / codebase.\n└── bakerydemo    # Wagtail Bakery project used for development.\n```\n\nOnce setup is over,\n\n```sh\n# 5. ssh into your new Vagrant virtual machine.\nvagrant ssh\n# 6. Start up the bakerydemo development server.\n./manage.py runserver 0.0.0.0:8000\n# Success!\n```\n\nAlternatively, if you're using VSCode and have the \"Remote - SSH\" extension, you can connect VSCode to the vagrant VM directly. This allows for much deeper debugging. Once connected, open the `/vagrant` directory. A debug `launch.json` is included and ready to go.\n\nOnce wagtail is up and running,\n\n- Visit your site at http://localhost:8000\n- The admin interface is at http://localhost:8000/admin/ - log in with `admin` / `changeme`.\n\nWhat you can do\n---------------\n\n\u003e Note: all of those commands are meant to be used **inside the Vagrant virtual machine**. To get there, go to your local Wagtail (`cd ~/Development/wagtail-dev`) set up and `vagrant up` then `vagrant ssh`.\n\nStart the bakerydemo server:\n\n```sh\n./manage.py runserver 0.0.0.0:8000\n# Then visit http://localhost:8000 in your browser.\n```\n\nRun the tests:\n\n```sh\ncd /vagrant/wagtail\n# Python tests.\n./runtests.py\n# Node tests.\nnpm run test\n```\n\nRun the linting:\n\n```sh\ncd /vagrant/wagtail\n# Python linting.\nmake lint\n# JavaScript linting.\nnpm run lint\n```\n\nBuild front-end assets:\n\n```sh\ncd /vagrant/wagtail\nnpm run build\n```\n\nStart front-end development tools and file watching:\n\n```sh\ncd /vagrant/wagtail\nnpm run start\n```\n\nBuild the documentation:\n\n```sh\ncd /vagrant/wagtail/docs\nmake html\n```\n\n\nGetting ready to contribute\n---------------------------\n\nHere are other actions you will likely need to do to make your first contribution to the project.\n\nSet up git remotes to Wagtail forks (run these lines outside of the Vagrant VM):\n\n```sh\ncd ~/Development/wagtail-dev/wagtail\n# Change the default origin remote to point to your fork.\ngit remote set-url origin git@github.com:\u003cUSERNAME\u003e/wagtail.git\n# Add wagtail/wagtail as the \"upstream\" remote.\ngit remote add upstream git@github.com:wagtail/wagtail.git\n# Add springload/wagtail as the \"springload\" remote.\ngit remote add springload git@github.com:springload/wagtail.git\n# Add gasman/wagtail as the \"gasman\" remote.\ngit remote add gasman git@github.com:gasman/wagtail.git\n# Pull latest changes from all remotes / forks.\ngit pull --all\n```\n\n## See also\n\n- [Docker Wagtail development](https://github.com/wagtail/docker-wagtail-develop)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwagtail%2Fvagrant-wagtail-develop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwagtail%2Fvagrant-wagtail-develop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwagtail%2Fvagrant-wagtail-develop/lists"}