# hust-os-bot

**Repository Path**: hust-open-atom-club/hust-os-bot

## Basic Information

- **Project Name**: hust-os-bot
- **Description**: Hust OS Contribution 邮件任务机器人
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-07-08
- **Last Updated**: 2024-01-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Hust OS Contribution Mail List Bot

## Build

### Prerequisite

node >= 14

### Install dependencies

```
npm install
```

### Debug Run

```
npm start

```

### Release build

```
npm run build
```

## Usage

### Environments

- SECRETS_FILE: file to secrets configuration, default `.secrets.json` 
- CRON_EXP: specify when to execute the schedule, default is every 3 minutes.
- CC_EMAIL: specify email to filter, default is HUST google groups email address.