https://github.com/userfrosting/web
The official website for UserFrosting
https://github.com/userfrosting/web
userfrosting userfrosting-documentation
Last synced: 5 months ago
JSON representation
The official website for UserFrosting
- Host: GitHub
- URL: https://github.com/userfrosting/web
- Owner: userfrosting
- Created: 2017-01-15T00:28:05.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T00:30:10.000Z (about 2 years ago)
- Last Synced: 2025-06-12T22:40:30.431Z (about 1 year ago)
- Topics: userfrosting, userfrosting-documentation
- Language: JavaScript
- Homepage: https://www.userfrosting.com
- Size: 40.8 MB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](http://getgrav.org).
## Local installation
### Step 1 - Install Grav
This application uses the [Grav](https://learn.getgrav.org/) 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](https://getgrav.org/blog/developing-with-github-part-2), to make it easier to deploy changes to the live server.
To install this website on your computer, first [install grav core](https://getgrav.org/downloads) 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/](http://localhost:8080/).
To stop the container:
```bash
docker stop userfrosting-web
```
To access Grav command line utility or gpm, you can use :
```bash
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/