Contributing to an existing project

This article is a work in progress. Some or most of it is still evolving and you should expect some level of inaccuracies.

Getting up and running

  • On your computer, create a folder named after your project.

  • Download the latest version of GRAV Core + ADMIN.

  • Unzip the downloaded Grav folder and put it in you project folder.

  • Rename the Grav directory to grav-admin.

  • From inside grav-admin, cut the user folder and paste it right next to grav-admin.

  • At that point, your project folder should look like this:

myproject
  grav-admin
  user
  • Clone the theme repo you are working on in the project folder, next to the other ones so it looks like...
myproject
  grav-admin
  grav-theme-mytheme
  user
  • Make sure you are always working in the develop branch.

Symlinks

Since our 3 main folder (admin, theme and user) are side by side in our project folder, and probably not in our XAMPP web root, we need to symlink everything together. You'll have to change the paths bellow to fit with your setup. I usually keep a copy of this the _SETUP folder in the theme repo so I can get back on my feet quickly if anything happen.

Local webroot to Grav install

mklink /D D:\xampp\htdocs\myproject D:\myproject\grav-admin

grav-admin to user

mklink /D D:\myproject\grav-admin\user D:\myproject\user

user to theme

mklink /D D:\myproject\user\themes\mytheme D:\myproject\grav-theme-mytheme

Test your setup using your favorite browser by going to your local web root (something like 127.0.0.1/myproject). If everything goes well, Grav will prompt you to create an account. At that point, you can consider the whole operation a success.

Login into the admin panel, go to "Themes" and activate the desired theme.

This article is a work in progress. Some or most of it is still evolving and you should expect some level of inaccuracies.

Getting up and running

  • On your computer, create a folder named after your project.

  • Download the latest version of GRAV Core + ADMIN.

  • Unzip the downloaded Grav folder and put it in you project folder.

  • Rename the Grav directory to grav-admin.

  • From inside grav-admin, cut the user folder and paste it right next to grav-admin.

  • At that point, your project folder should look like this:

myproject
  grav-admin
  user
  • Clone the theme repo you are working on in the project folder, next to the other ones so it looks like...
myproject
  grav-admin
  grav-theme-mytheme
  user
  • Make sure you are always working in the develop branch.

Symlinks

Since our 3 main folder (admin, theme and user) are side by side in our project folder, and probably not in our XAMPP web root, we need to symlink everything together. You'll have to change the paths bellow to fit with your setup. I usually keep a copy of this the _SETUP folder in the theme repo so I can get back on my feet quickly if anything happen.

Local webroot to Grav install

mklink /D D:\xampp\htdocs\myproject D:\myproject\grav-admin

grav-admin to user

mklink /D D:\myproject\grav-admin\user D:\myproject\user

user to theme

mklink /D D:\myproject\user\themes\mytheme D:\myproject\grav-theme-mytheme

Test your setup using your favorite browser by going to your local web root (something like 127.0.0.1/myproject). If everything goes well, Grav will prompt you to create an account. At that point, you can consider the whole operation a success.

Login into the admin panel, go to "Themes" and activate the desired theme.

🥰
Welcome back!

👋
You've been logged out.