Skip to content

Latest commit

 

History

History
100 lines (66 loc) · 4.11 KB

readme.md

File metadata and controls

100 lines (66 loc) · 4.11 KB

Fans of LeFox

Hugo website Hinode theme npm package UptimeRobot Status Last commit Issues Pulls License

This is the repository for the website Fans of LeFox. It houses both all of the code and all the content except large form media.

Licensing

All original literary content on this site is licensed CC BY-NC-SA 4.0. Excluded from this license are the sections /news/ and /transcript/, as well as most images. All attempts have been made to properly attribute images, however that may not be easily evident when viewing the code.

All code is licensed Apache License 2.0.

Powered By

Content

All content is located in the /content/ folder and are separated into subdivisions as follows.

/assets/

All javascript, css, and images. this includes any local images.

/data/

Formatted data (like a database).

  • filmography.json - acting, writing, self, etc.
  • history.yml - the history of FLF
  • /episodes/* - All the episodes for the TV shows, with scores, excerpts, and production information.

/posts/

All the *.md files of pure content.

  • /blog/ - blog posts
  • /faq/ - frequently asked questions, but also stored redirects like the gallery or wiki
  • /library/ - the library/wiki of all historical information
  • /tos/ - terms of use and privacy information

/library/

  • /actor/ - all acting roles
  • /advocacy/ - all advocacy work
  • /biographies/ - all bios from all sources (movies, TV, etc)
  • /news/ - news articles, separated by year
  • /producer/ - all work done as a producer
  • /recaps/ - TV episode recaps
  • /self/ - appearances in media as herself
  • /transcripts/ - interviews, online and off, sorted by year
  • /writer/ - work done as a writer

Installation

  • Checkout from Github
  • Run npm install
  • Run npm run mod:update

Build

To build the site, run npm run build

Building the site will create a local copy of the site in your public_html folder. The first build may take up to fifteen minutes, as it will download and render all the remote media, storing it in the resources folder. Subsequent builds will take less time, as it only downloads new media added in the content. The deployment builds keep a remote copy of that folder to expedite deployment.

Upgrade

To upgrade the backend site code, run npm run upgrade

This will update all the libraries and mods.

Development

When the production branch is updated, it will automatically push the code to the server.

  1. Create a new branch to work on based on production
  2. Test locally: npm run start
  3. Validate all MD files: npm run lint
  4. Push branch to GitHub
  5. Open a PR to production

A lead dev will review and merge.

Staging / Testing

The staging server can be found at staging.jorjafox.net and is password protected.

To push code to staging, run npm run merge-to-trunk