godotengine/godot-website
1
0
Fork 0
mirror of https://github.com/godotengine/godot-website.git synced 2025-12-31 09:48:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
852f382aca896d2cd3c9ffd801a5c6b621b57336
godot-website/README.md
Hugo Locurcio 852f382aca Store Patreon plugin inside the repository 
This removes the need to initialize a (broken) submodule URL
to get a local copy of the website running.

The plugin was cloned from https://github.com/pcvonz/oc-patreongoalstatus-plugin
(commit 5d685ddc9bbb522d668f7906185f24b1319da3b3).
2020-06-25 14:24:04 +02:00

2.8 KiB
Raw Blame History

Godot Website

This repository contains the theme and plugins used in Godot Engine's October instance.

Development

Dependencies

  • Docker
  • Node.js (8.x or newer)
    • If you cannot get a recent version from your distribution's repositories, try using fnm.
  • Yarn

Running the site

  • Clone this repository.
  • Put a database dump (if you have one) into the /docker/mariadb/init folder.
    • Make sure that your script starts with the line USE october; and that the file extension is .sql.
  • Run the ./docker/restart.sh script (this will take a while the first time).
  • You might need to reinstall some plugins /docker/php/install-plugin.sh author.name.
    • Replace author.name with the names in the /plugins/[author]/[name] folders.
  • See the website at http://localhost:8080.

Restoring a database

  • mv /your/dump/backup-file.sql ./docker/mariadb/init
  • ./docker/mariadb/bash.sh
  • cd /docker-entrypoint-initdb.d/
  • mysql < 000-setup.sql
  • mysql < backup-file.sql

Interfacing with the Docker containers

You can use the standard docker exec -it godotengine-org--[php|mariadb] [command] syntax or the following scripts:

  • ./docker/php/bash.sh
  • ./docker/php/install-plugin.sh
  • ./docker/php/log.sh
  • ./docker/mariadb/bash.sh
  • ./docker/mariadb/log.sh
  • ./docker/mariadb/mysql.sh

Setting up the theme

  • Log into the October backend and change the frontend theme from the Settings tab.
  • While examining the frontpage, you'll notice that nothing is styled; this is because we need to compile the CSS from our SCSS. Make sure you have Node.js installed.
  • Change directory into themes/godotengine then run yarn install && yarn build.
  • Change directory into plugins/paulvonzimmerman/patreon then run composer install.
  • You should now have approximately what's in production. The only missing pieces are everything that's stored in the production database (devblog entries and featured games).

Deploying your changes

Deploying is of course only possible to people who have access to our production server. Most contributors should submit a pull request instead.

  • Copy example_conf.json: cp example_conf.json conf.json.
  • Fill out your credentials in conf.json.
  • Run yarn deploy.

This will copy all the compiled assets from the godotengine/assets/packed directory to the corresponding directory on production. It'll also make sure that copied assets are still writable by the group on the server. Make sure you've thoroughly tested your changes on your local copy before running this.

Resources

  • Discuss on freenode IRC: #godotengine-atelier
  • When working on the theme, please take note of the website stats.