Development environment installation
Cloning the repository#
The project source code is hosted on Github. To get started, fork the repository and then clone it to your local development machine.
Installing Vagrant#
The main development for Gitzer occurs using Vagrant and all the associated scripts to setup a development environment for Gitzer are already present in the repository.
You can install Vagrant from here. Once you have
downloaded it, you can verify your installation using vagrant --version. At the time
of writing this guide, the output of that command is Vagrant 2.2.14. You might have to
restart your machine after installing Vagrant.
Starting the virtual machine#
Once you have verified your installation, you can start the provisioning of the machine with the following command:
Typically, provisioning can take anywhere from 10 to 15 minutes.
info
You will have to create a file gitzer-frontend/.env with the following contents:
Verification#
If all went well, you should have a functioning development environment now. To verify,
run vagrant ssh in the project root. This will directly drop you into a terminal
session of the machine that you just provisioned. Run the following commands to verify
if it works correctly.
Open up your browser and visit http://127.0.0.1:8000/ to access the backend development
server powered by Django. Visit http://127.0.0.1:3000/ to access the frontend development
server powered by NuxtJs.
info
The run-dev script doesn't start up the documentation development server by default.
To launch that, run the following commands:
Then visit http://127.0.0.1:8080/ in your web browser to access the documentation
development server powered by Docusaurus.