Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
meetqy committed Jan 2, 2024
1 parent a0b5980 commit eab5e59
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 36 deletions.
63 changes: 28 additions & 35 deletions README-EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,44 +67,37 @@ PC
- 📌 The default theme supports PWA, you can save it as an app without opening the browser every time
- 🎊 Can access materials without relying on management software, and can even be deployed on Windows/MacOS servers
## Contribution
We welcome anyone interested in helping to improve Rao.Pics. If you want to contribute, there are several ways to participate:
- Bug fixes: If you find a bug, please create a pull request with a clear description of the problem and the solution. Quick entry => [🐞 Submit Bug](https://github.com/meetqy/rao-pics/issues/new?assignees=&labels=Bug&projects=&template=bug_report.yml&title=bug%3A+)
- Improvements: Do you have any ideas to improve Rao.Pics? Please create an issue first to discuss why this improvement is needed. Quick entry => [🛠 Feature Request](https://github.com/meetqy/rao-pics/issues/new?assignees=&labels=%E2%9C%A8+enhancement&projects=&template=feature_request.yml&title=feat%3A+)
## Build
These commands are for maintainers only.
**Environment Information**
- nodejs >= `v18.17.1`
- pnpm >= `8.7.6`
**Pull the code**
## Custom Domain
Using `Nginx` as an example, let's say you want to customize the domain to `desktop.rao.pics`.
1. In the App/Settings, enter `https://desktop.rao.pics`.
2. Configure Nginx as follows:
```nginx
server {
listen 80;
server_name desktop.rao.pics;
location / {
proxy_pass http://localhost:61121; # App/设置 中的网页端口
proxy_set_header Host $proxy_host;
proxy_set_header X-Real-Ip $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
location /trpc {
proxy_pass http://localhost:61122; # App/设置 中的服务端口
proxy_set_header Host $proxy_host;
proxy_set_header X-Real-Ip $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
}
```
git clone https://github.com/meetqy/rao-pics.git
```
**Install Dependencies**
Install dependencies using pnpm
```
pnpm i
```
## Contribute
**Run**
`pnpm dev` will run three projects simultaneously: `packages/db`, `themes/gallery`, `apps/electron`
```
pnpm dev
```
[贡献指南](./CONTRIBUTING.md)
## Support the Author
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ PC
`Nginx` 作为示例,假设需要自定义的域名为:`desktop.rao.pics`
1. 在 App/设置 中,填写 `https://desktop.rao.pics`
2. nginx 中配置
2. Nginx 中配置
```nginx
server {
Expand Down

0 comments on commit eab5e59

Please sign in to comment.