https://github.com/jaydenseric/ruck-website
The ruck.tech website for Ruck, an open source buildless React web application framework for Deno.
https://github.com/jaydenseric/ruck-website
deno react
Last synced: 8 months ago
JSON representation
The ruck.tech website for Ruck, an open source buildless React web application framework for Deno.
- Host: GitHub
- URL: https://github.com/jaydenseric/ruck-website
- Owner: jaydenseric
- License: mit
- Created: 2022-03-11T08:13:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T10:13:13.000Z (over 1 year ago)
- Last Synced: 2025-05-09T00:43:47.852Z (about 1 year ago)
- Topics: deno, react
- Language: JavaScript
- Homepage: https://ruck.tech
- Size: 101 KB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license.md
Awesome Lists containing this project
README
# 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
```