Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tanhongit authored Nov 6, 2024
1 parent ad5ca77 commit 01df71c
Showing 1 changed file with 1 addition and 69 deletions.
70 changes: 1 addition & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
a# CSlant Home Runner
# CSlant Home Runner

```text
██╗ ██╗ ██████╗ ███╗ ███╗███████╗ ██████╗ ██╗ ██╗███╗ ██╗███╗ ██╗███████╗██████╗
Expand Down Expand Up @@ -66,71 +66,3 @@ The runner has the following commands:
| `build`, `b` | Builds the Home |
| `worker`, `w` | Create or restart the worker |
| `all`, `a` | Runs all the commands |
# CSlant Home Runner

```text
██╗ ██╗ ██████╗ ███╗ ███╗███████╗ ██████╗ ██╗ ██╗███╗ ██╗███╗ ██╗███████╗██████╗
██║ ██║██╔═══██╗████╗ ████║██╔════╝ ██╔══██╗██║ ██║████╗ ██║████╗ ██║██╔════╝██╔══██╗
███████║██║ ██║██╔████╔██║█████╗ ██████╔╝██║ ██║██╔██╗ ██║██╔██╗ ██║█████╗ ██████╔╝
██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ██╔══██╗██║ ██║██║╚██╗██║██║╚██╗██║██╔══╝ ██╔══██╗
██║ ██║╚██████╔╝██║ ╚═╝ ██║███████╗ ██║ ██║╚██████╔╝██║ ╚████║██║ ╚████║███████╗██║ ██║
╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═══╝╚══════╝╚═╝ ╚═╝
```

This repo is to set up the runner for updating homepage at https://cslant.com

We can use this runner to update the Home automatically with CI/CD pipelines.

## Installation

First, copy the `.env.example` file to `.env` and update the values.

```bash
envsubst < .env.example > .env
```

In the `.env` file, update the values to match your environment.

```bash
# .env

#SOURCE_DIR=~/source
SOURCE_DIR=/home/user/cslant.com/home

[email protected]:cslant

# The name of the runner
WORKER_NAME="CSlant Home"

# add the env to choose "npm" or "yarn" as the installer
INSTALLER=yarn

# App Config
# E.g: prod, dev
ENV=prod

NODE_VERSION=22

USE_SUBMODULES=false
```

> [!IMPORTANT]
> ## Command can't be used if wrong values are set in the `.env` file.
> * If the `SOURCE_DIR` is wrong, the runner will not be able to find the source code. So, please make sure the `SOURCE_DIR` is correct.
Then, run the following command to start the runner.

```bash
bash runner.sh all
```

## Usage

The runner has the following commands:

| Command | Description |
|----------|------------------------------|
| `help` | Shows the help message |
| `build` | Builds the Home |
| `worker` | Create or restart the worker |
| `all` | Runs all the commands |

0 comments on commit 01df71c

Please sign in to comment.