Ruck website

The ruck.tech website for Ruck, an open source buildless React web application framework for Deno.

Requirements

• Deno CLI v2+.

Installation

For a local development installation, create a project scripts/.env.sh file containing the following environment variables, with values customized for your local environment:

# Development or production mode; "true" or "false".
export RUCK_DEV="true"

# The localhost port to serve the Ruck app on.
export RUCK_PORT="3000"

# GitHub access token used with the GitHub GraphQL API to query the
# jaydenseric/ruck repo releases for the releases related Ruck app routes.
export ACCESS_TOKEN_GITHUB=""

Scripts

Dev

To load the environment variables from scripts/.env.sh, make the public environment variable modules, and serve the Ruck app:

./scripts/dev.sh

Make public environment variable modules

Important

Requires environment variables.

To make the public environment variable modules:

./scripts/makeEnvModules.sh

Serve

Important

Requires environment variables.

To serve the Ruck app for either development or production:

./scripts/serve.sh

Format

To format the project:

deno fmt

Lint

To lint the project:

deno lint

Type check

Important

Beforehand, run the make public environment variable modules script.

To type check every JavaScript module in the project:

./scripts/type-check.sh