Skip to content

allofphysicsgraph/allofphysics.com

Repository files navigation

This repo is the source code for the website https://allofphysics.com, aka https://derivationmap.net/.

How to use (for the impatient)

git clone https://github.com/allofphysicsgraph/allofphysics.com.git
cd allofphysics.com
make up

See developer documentation after reading the user documentation

Files not in this repo

  • certs/dhparam.pem
  • certs/fullchain.pem
  • certs/privkey.pem
  • .env

The certs/*.pem are generated by Let's Encrypt

The .env file contains three lines,

GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
SECRET_KEY=

build and run

docker compose up --build --remove-orphans

or

docker compose up --build --remove-orphans --detach

or

docker compose up --build --force-recreate --remove-orphans --detach

As a two step process

docker compose build --progress tty
docker compose up

Software Requirements

  • Docker
  • a web browser

Software Versions

Because software is in Docker containers (for reproducibility), the versions of the Docker software you're using matter. The software in this repo has been tested with

which is gathered by running

$ docker compose version
Docker Compose version v2.29.2
$ docker version
Client: Docker Engine - Community
 Version:           27.2.0
 API version:       1.47
 Go version:        go1.21.13
 Git commit:        3ab4256
 Built:             Tue Aug 27 14:15:15 2024
 OS/Arch:           linux/amd64
 Context:           default

Server: Docker Engine - Community
 Engine:
  Version:          27.2.0
  API version:      1.47 (minimum version 1.24)
  Go version:       go1.21.13
  Git commit:       3ab5c7d
  Built:            Tue Aug 27 14:15:15 2024
  OS/Arch:          linux/amd64
  Experimental:     false
 containerd:
  Version:          1.7.21
  GitCommit:        472731909fa34bd7bc9c087e4c27943f9835f111
 runc:
  Version:          1.1.13
  GitCommit:        v1.1.13-0-g58aa920
 docker-init:
  Version:          0.19.0
  GitCommit:        de40ad0

Licensing

Unless otherwise noted, all source code is covered by the Creative Commons Attribution 4.0 International License