init:新增项目说明

This commit is contained in:
yanqs 2024-08-12 09:47:24 +08:00
commit c1365d1539
2 changed files with 72 additions and 0 deletions

44
.gitignore vendored Normal file
View File

@ -0,0 +1,44 @@
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
.idea
*.iws
*.iml
*.ipr
### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/
### Mac OS ###
.DS_Store
### CodeArts IDE
.arts
.jlsp

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# rss-reader
RSS阅读器基于Java SpringBoot搭建。
## 部署运行
```shell
docker run -d --restart=always \
-v ./config:/app/config \
-v ./log:/app/log \
-v ./images:/app/images \
-v /etc/localtime:/etc/localtime:ro \
--name rss-reader \
bcrjl/rss-reader:latest
```
打开`data.json`配置需要订阅的RSS源;打开`config.setting`配置系统参数;
以上配置均为动态刷新,无需重启容器
### 映射目录说明
| 本地目录 | 容器目录 | 说明 |
| --- | --- |-------|
| ./config | /app/config | 配置文件 |
| ./log | /app/log | 运行日志 |
| ./images | /app/images | 下载的文件 |