|
1 | | -# React + TypeScript + Vite |
| 1 | +# RSS Watcher |
2 | 2 |
|
3 | | -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. |
| 3 | +A modern web application for monitoring RSS feeds and receiving notifications when new posts match your keywords. Built with React, Express, and TypeScript. |
4 | 4 |
|
5 | | -Currently, two official plugins are available: |
| 5 | +## Features |
6 | 6 |
|
7 | | -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh |
8 | | -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh |
| 7 | +- 🔍 Monitor multiple RSS feeds simultaneously |
| 8 | +- 🔑 Define custom keywords for each feed |
| 9 | +- 🔔 Real-time notifications via [ntfy.sh](https://ntfy.sh) |
| 10 | +- ⏰ Configurable check intervals |
| 11 | +- 📱 Responsive web interface |
| 12 | +- 📜 Detailed feed history tracking |
| 13 | +- 🚦 Live feed status monitoring |
9 | 14 |
|
10 | | -## Expanding the ESLint configuration |
| 15 | +## Getting Started |
11 | 16 |
|
12 | | -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: |
| 17 | +### Prerequisites |
13 | 18 |
|
14 | | -- Configure the top-level `parserOptions` property like this: |
| 19 | +- Node.js (v14 or higher) |
| 20 | +- npm or yarn |
15 | 21 |
|
16 | | -```js |
17 | | -export default tseslint.config({ |
18 | | - languageOptions: { |
19 | | - // other options... |
20 | | - parserOptions: { |
21 | | - project: ['./tsconfig.node.json', './tsconfig.app.json'], |
22 | | - tsconfigRootDir: import.meta.dirname, |
23 | | - }, |
24 | | - }, |
25 | | -}) |
| 22 | +### Installation |
| 23 | + |
| 24 | +1. Clone the repository: |
| 25 | +```bash |
| 26 | +git clone https://github.com/ablomer/rsswatcher.git |
| 27 | +cd rsswatcher |
| 28 | +``` |
| 29 | + |
| 30 | +2. Install dependencies: |
| 31 | +```bash |
| 32 | +npm install |
| 33 | +# or |
| 34 | +yarn install |
| 35 | +``` |
| 36 | + |
| 37 | +### Development |
| 38 | + |
| 39 | +Run the development server: |
| 40 | + |
| 41 | +```bash |
| 42 | +npm run dev |
| 43 | +# or |
| 44 | +yarn dev |
26 | 45 | ``` |
27 | 46 |
|
28 | | -- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked` |
29 | | -- Optionally add `...tseslint.configs.stylisticTypeChecked` |
30 | | -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config: |
31 | | - |
32 | | -```js |
33 | | -// eslint.config.js |
34 | | -import react from 'eslint-plugin-react' |
35 | | - |
36 | | -export default tseslint.config({ |
37 | | - // Set the react version |
38 | | - settings: { react: { version: '18.3' } }, |
39 | | - plugins: { |
40 | | - // Add the react plugin |
41 | | - react, |
42 | | - }, |
43 | | - rules: { |
44 | | - // other rules... |
45 | | - // Enable its recommended rules |
46 | | - ...react.configs.recommended.rules, |
47 | | - ...react.configs['jsx-runtime'].rules, |
48 | | - }, |
49 | | -}) |
| 47 | +### Production |
| 48 | + |
| 49 | +Build and start the production server: |
| 50 | + |
| 51 | +```bash |
| 52 | +npm run build |
| 53 | +npm start |
| 54 | +# or |
| 55 | +yarn build |
| 56 | +yarn start |
50 | 57 | ``` |
| 58 | + |
| 59 | +Once the server is running, visit `http://localhost:3000` in your browser to access the web interface. |
| 60 | + |
| 61 | +## Configuration |
| 62 | + |
| 63 | +All configuration is managed through the web interface: |
| 64 | + |
| 65 | +### Feed Management |
| 66 | +- Add, edit, or remove RSS feeds through the "Feeds" tab |
| 67 | +- Set keywords for each feed to monitor |
| 68 | +- View feed status and history |
| 69 | + |
| 70 | +### Settings |
| 71 | +- Configure ntfy.sh notification settings in the "Settings" tab |
| 72 | + - Set your ntfy topic |
| 73 | + - Configure ntfy server address (defaults to https://ntfy.sh) |
| 74 | + - Adjust feed check interval |
| 75 | + |
| 76 | +## Docker Support |
| 77 | + |
| 78 | +Build the Docker image: |
| 79 | + |
| 80 | +```bash |
| 81 | +docker build -t rsswatcher . |
| 82 | +``` |
| 83 | + |
| 84 | +Run the container: |
| 85 | + |
| 86 | +```bash |
| 87 | +# Create a directory for persistent data |
| 88 | +mkdir -p data |
| 89 | + |
| 90 | +# Run the container with mounted data directory |
| 91 | +docker run -p 3000:3000 \ |
| 92 | + -v $(pwd)/data:/app/data \ |
| 93 | + rsswatcher |
| 94 | +``` |
| 95 | + |
| 96 | +This will persist all application data (configuration and history) across container restarts. |
| 97 | + |
| 98 | +## Contributing |
| 99 | + |
| 100 | +Contributions are welcome! Please feel free to submit a Pull Request. |
| 101 | + |
| 102 | +## License |
| 103 | + |
| 104 | +This project is licensed under the MIT License (see the [LICENSE](LICENSE) file for details). |
0 commit comments