orionrobots.github.io

Orionrobots website source

CC BY SA 3.0 - http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons By Attribution Share-Alike v3.0

Running serve and build in docker

Recommended: Using Docker Compose

Build the dist and serve:

docker compose up --build --remove-orphans

Get a bash prompt in the serve container:

docker compose run --interactive serve bash

Note: node_modules are managed inside the container. You do not need to run npm install on your host.

Preparing to contribute

This project uses the following tools for development:

• Docker compose to run the development environment
• pre-commit to run checks before committing changes
  • You will need to install pre-commit on your local machine with pip/pipx in a python environment.

You should create a named branch for your changes, before committing, as using PR's to contribute is preferred.

git checkout -b my-feature-branch

Running locally

You may need to determine dependencies - the docker method is preferred. Direct npm usage on the host is discouraged to avoid version mismatches.

If you make changes to htaccess

For an experience closer to hosting, use docker compose:

docker compose up web
[+] Running 1/0
⠿ Container orionrobotsgithubio-web-1 Created       0.0s
Attaching to orionrobotsgithubio-web-1
orionrobotsgithubio-web-1  | ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x86_64-linux-musl]