Skip to content

userfrosting/web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UserFrosting main site

https://www.userfrosting.com

This is the repository for the main UserFrosting 4 website. It is built with the flat-file CMS Grav.

Local installation

Step 1 - Install Grav

This application uses the Grav CMS. This repository does not contain a full Grav installation - rather, it just contains the contents of Grav's user directory, which is where all of our custom content, themes, and assets live. This was done as per the recommendation on Grav's blog, to make it easier to deploy changes to the live server.

To install this website on your computer, first install grav core in a project folder called userfrosting-web under your webserver's document root folder. Then, find the user folder inside of your project folder. Delete the contents of the user folder and clone this repository directly into the user folder.

When you're done it should look like this:

htdocs/
└── userfrosting-web/
   ├── assets/
   ├── ...
   ├── user/
       ├── .git
       ├── accounts/
       ├── assets/
       ├── config/
       └── ...
   └── ...

Step 2

Grav needs your webserver to be able to write to certain directories. In OSX with XAMPP installed, this won't work by default. To deal with this:

Add default webserver user daemon to OSX's staff group (which already has the necessary permissions for writing to files/directories):

sudo dseditgroup -o edit -a daemon -t user staff

Docker Installation

  1. Clone repo

    git clone https://github.com/userfrosting/web.git userfrosting-web
    cd userfrosting-web
    
  2. Build Grav container

    docker build -t grav:latest .
    
  3. Start Grav container

    docker run -d --rm --name=userfrosting-web -p 8080:80 -v "$(pwd):/var/www/grav/user" grav:latest
    

It will take a couples of second for the site to be up and running while the base Grav installation is done. Once this is complete, you can access the website at http://localhost:8080/.

To stop the container:

docker stop userfrosting-web

To access Grav command line utility or gpm, you can use :

docker exec -it userfrosting-web bash
chmod +x bin/gpm # This is only needed if permissions are acting up
bin/grav install

Credits

Favicons were generated with https://realfavicongenerator.net/