mirror of
https://github.com/Afilmory/afilmory
synced 2026-02-01 22:48:17 +00:00
fix: omit default config social field, fixed #30
- Removed outdated setup instructions and configuration examples from README.md to streamline documentation. - Updated site.config.ts by removing unused social media fields for a cleaner configuration structure. Signed-off-by: Innei <tukon479@gmail.com>
This commit is contained in:
100
README.md
100
README.md
@@ -79,105 +79,6 @@ Designed with adapter pattern, supporting multiple storage backends:
|
||||
|
||||
[Docker Deployment](https://github.com/Afilmory/docker)
|
||||
|
||||
### Requirements
|
||||
|
||||
- Node.js 18+
|
||||
- At least 4GB RAM (for image processing)
|
||||
|
||||
### 1. Clone the Project
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Afilmory/Afilmory.git
|
||||
cd photo-gallery-site
|
||||
```
|
||||
|
||||
### 2. Install Dependencies
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
### 3. Configuration
|
||||
|
||||
Create `.env` file:
|
||||
|
||||
```env
|
||||
# S3 Storage Keys
|
||||
S3_ACCESS_KEY_ID=your_access_key_id
|
||||
S3_SECRET_ACCESS_KEY=your_secret_access_key
|
||||
```
|
||||
|
||||
Create `builder.config.json` file for storage configuration and other options:
|
||||
|
||||
```json
|
||||
{
|
||||
"storage": {
|
||||
"provider": "s3",
|
||||
"bucket": "my-photos",
|
||||
"region": "us-east-1",
|
||||
"prefix": "photos/",
|
||||
"customDomain": "https://cdn.example.com",
|
||||
"endpoint": "https://s3.amazonaws.com"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4. Site Configuration
|
||||
|
||||
Copy and edit the configuration file:
|
||||
|
||||
```bash
|
||||
cp config.example.json config.json
|
||||
```
|
||||
|
||||
Edit `config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "My Afilmory",
|
||||
"title": "My Afilmory",
|
||||
"description": "Capturing beautiful moments in life",
|
||||
"url": "https://afilmory.example.com",
|
||||
"accentColor": "#007bff", // Optional, set theme color
|
||||
"author": {
|
||||
"name": "Your Name", // Required, set author name
|
||||
"url": "https://example.com", // Required, set author homepage
|
||||
"avatar": "https://example.com/avatar.png" // Required, set author avatar
|
||||
},
|
||||
"social": {
|
||||
// Optional, set social accounts
|
||||
"twitter": "@yourusername"
|
||||
},
|
||||
"feed": {
|
||||
"folo": { // Optional, set Folo RSS claim
|
||||
"challenge": {
|
||||
"feedId": "155982289762921472",
|
||||
"userId": "41312624216137728"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 5. Build Photo Manifest
|
||||
|
||||
```bash
|
||||
# Initial build
|
||||
pnpm run build:manifest
|
||||
|
||||
# Incremental update
|
||||
pnpm run build:manifest
|
||||
|
||||
# Force full update
|
||||
pnpm run build:manifest -- --force
|
||||
```
|
||||
|
||||
### 6. Start Development Server
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## ⚙️ Configuration Options
|
||||
|
||||
#### Remote Repository Configuration (`repo`)
|
||||
@@ -226,7 +127,6 @@ This will automatically pull resources from the remote repository, avoiding rebu
|
||||
- `level`: Log level (`info` | `warn` | `error` | `debug`)
|
||||
- `outputToFile`: Output to file
|
||||
|
||||
|
||||
## 📋 CLI Commands
|
||||
|
||||
### Build Commands
|
||||
|
||||
@@ -27,8 +27,8 @@ interface Author {
|
||||
avatar?: string
|
||||
}
|
||||
interface Social {
|
||||
twitter: string
|
||||
github: string
|
||||
twitter?: string
|
||||
github?: string
|
||||
}
|
||||
|
||||
const defaultConfig: SiteConfig = {
|
||||
@@ -43,10 +43,6 @@ const defaultConfig: SiteConfig = {
|
||||
url: 'https://innei.in/',
|
||||
avatar: 'https://cdn.jsdelivr.net/gh/Innei/static@master/avatar.png',
|
||||
},
|
||||
social: {
|
||||
twitter: '@__oQuery',
|
||||
github: 'Innei',
|
||||
},
|
||||
}
|
||||
export const siteConfig: SiteConfig = merge(defaultConfig, userConfig) as any
|
||||
|
||||
|
||||
Reference in New Issue
Block a user