Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gezhaoyou committed Apr 25, 2024
1 parent 96e5a9e commit 53326e5
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
<h1 align="center"> PicProse </h1>

<p align="center">
<a href="https://github.com/gezhaoyou/picprose/stargazers"><img alt="PicProse Stars" src="https://img.shields.io/github/stars/gezhaoyou/picprose?style=social"/></a>
<a href="https://github.com/gezhaoyou/picprose/releases/latest"><img alt="PicProse Release" src="https://img.shields.io/github/v/release/gezhaoyou/picprose"/></a>
<a href="https://github.com/gezhaoyou/picprose/blob/main/LICENSE"><img alt="PicProse Stars" src="https://img.shields.io/github/license/gezhaoyou/picprose"/></a>
</p>

> 👉 Unsplash 限制每小时最多50次请求,若出现图库加载不出来,请稍后再试
> 👉 Unsplash limits requests to a maximum of 50 per hour. If the image library fails to load, please try again later.
## Intro
PicProse is a article cover image generator tool for Medium, Wordpress, Wechat and other blog post

**Preview:** [https://picprose.net](https://picprose.net) or [https://picprose.pixpark.net/](https://picprose.pixpark.net/)(China)
**Preview:**
[https://picprose.net](https://picprose.net)

**User:** [https://pixpark.net](https://pixpark.net)
[https://picprose.pixpark.net/](https://picprose.pixpark.net/)(Chinese mainland)

![preview](./doc/preview.jpg)
**Showcase:**
[https://pixpark.net](https://pixpark.net)

![preview](./doc/screenshot.png)

## Getting Started

**First:**
**Step 1:**
config Unsplash key

💡 create file `.env.local`, put in your unsplash key
Expand All @@ -19,17 +34,15 @@ NEXT_PUBLIC_UNSPLASH_API_KEY = your_unsplash_api_key
Refer: [https://unsplash.com/documentation](https://unsplash.com/documentation)


**Second:**
**Step 2:**
Run the development server:

```bash
npm install
npm run dev
# or
yarn install
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
Expand All @@ -38,7 +51,7 @@ You can start editing the page by modifying `app/page.tsx`. The page auto-update

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Deploy
## Deploy Static

Run
```bash
Expand All @@ -53,7 +66,7 @@ You can start by creating your own Nextra site and deploying to Vercel by clicki
target="_blank"
href="https://vercel.com/new/clone?s=https://github.com/gezhaoyou/picprose&showOptionalTeamCreation=false">![](https://vercel.com/button)</a>

## Deploy to Docker
## Deploy with Docker

```sh
docker run -d --name picprose -e NEXT_PUBLIC_UNSPLASH_API_KEY=xxx -p 3000:3000 hausen1012/picprose
Expand Down
Binary file removed doc/preview.jpg
Binary file not shown.
Binary file added doc/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 53326e5

Please sign in to comment.