BMorePunkWebsite

This repository contains the Source code for the BMorePunk.social website. The website is built using Aurora, which outputs a static HTML website.

Building the website

Installing Aurora and setting up the enviornment

This guide assumes that you are using a Debian based Linux distribution such as Debian, Ubuntu, Mint, or Raspbian.

1. Install python3 and python3-pip
   sudo apt install python3 python3-pip
2. Create a directory for Aurora to live in
   mkdir ~/Documents/BMorePunkAurora/
3. Create a venv for Python3
   python -m venv ~/Documents/BMorePunkAurora/
4. Enter the venv
   cd ~/Documents/BMorePunkAurora/
source bin/activate
5. Install Aurora
   pip3 install aurora-ssg
6. Download the repository
   git clone ssh://git@forge.bmorepunk.social/BMorePunkTech/BMorePunkWebsite.git

Building the website (development)

1. Ensure that you are in the venv. If you've just come from the previous section, then you should already be in the venv. If you are not, use the following commands to enter it.
   cd ~/Documents/BMorePunkAurora/
source bin/activate
2. Switch to the BMorePunkWebsite directory
   cd BMorePunkWebsite
3. Run Aurora
   aurora serve

Aurora will launch a webserver at http://localhost:8000 that you can access to view a live copy of the website as you make edits.

Building the website (production)

1. Ensure that you are in the venv. If you've just come from the previous section, or the installation section, then you should already be in the venv. If you are not, use the following commands to enter it.
   cd ~/Documents/BMorePunkAurora/
source bin/activate
2. Ensure you are in the BMorePunkWebsite directory. If you've just come from the previous section, then you should already be in the correct directory. If you've just entered the venv in step one run the following command to enter the BMorePunkWebsite directory.
   cd BMorePunkWebsite
3. Run Aurora
   aurora build

Aurora will output named _site containing the static website. This then gets uploaded to the BMorePunk webserver at /var/www/_site/.

Folder layout

.
├── assets
│   ├── bands
│   ├── fonts
│   ├── venues
│   └── zines
└── pages
    ├── _data
    ├── _layouts
    ├── posts
    └── templates

Everything in the assets directory gets served as is under /assets/ on the website.

Within the pages directory you will find the bulk of the website.

All of the data for our band and venue directory is stored in the _data directory. The data is stored in JSON files. These are then rendered using the HTML files in the _layouts directory.

All of the posts from the announcements are stored as Markdown files within the posts directory. These are rendered using a file in the _layouts directory.

Finally the templates directory contains all of the individual specific named pages on the website. These snippets of HTML are also rendered using the files in the _layouts directory.