# ruck-website

**Repository Path**: mirrors_jaydenseric/ruck-website

## Basic Information

- **Project Name**: ruck-website
- **Description**: The ruck.tech website for Ruck, an open source buildless React web application framework for Deno.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-12
- **Last Updated**: 2026-09-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![Ruck logo](./public/logos/ruck.svg)

# Ruck website

The [ruck.tech](https://ruck.tech) website for
[Ruck](https://github.com/jaydenseric/ruck), an open source buildless
[React](https://reactjs.org) web application framework for
[Deno](https://deno.land).

## Requirements

- [Deno CLI](https://deno.land/#installation) v2.4+.

## 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:

```sh
# 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](https://ruck.tech) app:

```sh
./scripts/dev.sh
```

### Make public environment variable modules

> [!IMPORTANT]
>
> Requires environment variables.

To make the public environment variable modules:

```sh
./scripts/makeEnvModules.sh
```

### Serve

> [!IMPORTANT]
>
> Requires environment variables.

To serve the [Ruck](https://ruck.tech) app for either development or production:

```sh
./scripts/serve.sh
```

### Format

To format the project:

```sh
deno fmt
```

### Lint

To lint the project:

```sh
deno lint
```

### Type check

> [!IMPORTANT]
>
> Beforehand, run the
> [make public environment variable modules](#make-public-environment-variable-modules)
> script.

To type check every JavaScript module in the project:

```sh
./scripts/type-check.sh
```