git.stevedylan.dev

chore: updated README and TODO 38342e22

Steve · 2025-10-28 20:31 2 file(s) · +23 −69

README.md +10 −69

# React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## React Compiler

The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).

## Expanding the ESLint configuration
# Alcove

If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
End-to-end encrypted RSS reader for the web

```js
export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...
> [!WARNING]
> Project is still under active development

      // Remove tseslint.configs.recommended and replace with this
      tseslint.configs.recommendedTypeChecked,
      // Alternatively, use this for stricter rules
      tseslint.configs.strictTypeChecked,
      // Optionally, add this for stylistic rules
      tseslint.configs.stylisticTypeChecked,
## Roadmap

      // Other configs...
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])
```

You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:

```js
// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...
      // Enable lint rules for React
      reactX.configs['recommended-typescript'],
      // Enable lint rules for React DOM
      reactDom.configs.recommended,
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])
```
- [ ] Mark posts as read/unread
- [ ] Import/Export OPML
- [ ] Import/Export account through mnemonic
- [ ] Refresh/Update Feeds
- [ ] Tweakcn theme switching

TODO.md (added) +13 −0

1	+	# To-Do Items
2	+
3	+	Endless rambling of things to fix and improve
4	+
5	+	- [ ] Add `publishedDate` to `rssPost`
6	+	- [ ] Order posts by newest first
7	+	- [ ] Instead of "by author" if Author is unavailable, use blog/feed name
8	+	- [ ] Add auto-find RSS feed when adding a feed
9	+	- [ ] Add error handling and checks for adding a feed
10	+	- [ ] Add loading states for new feed
11	+	- [ ] Find a way to paginate through feeds and get more posts if they only return a few
12	+	- [ ] Collapse both side bars if desired?
13	+	- [ ] Update logo in top left

1		-	# React + TypeScript + Vite
2		-
3		-	This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4		-
5		-	Currently, two official plugins are available:
6		-
7		-	- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
8		-	- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9		-
10		-	## React Compiler
11		-
12		-	The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
13		-
14		-	## Expanding the ESLint configuration
	1	+	# Alcove
15	2
16		-	If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
	3	+	End-to-end encrypted RSS reader for the web
17	4
18		-	```js
19		-	export default defineConfig([
20		-	globalIgnores(['dist']),
21		-	{
22		-	files: ['*/.{ts,tsx}'],
23		-	extends: [
24		-	// Other configs...
	5	+	> [!WARNING]
	6	+	> Project is still under active development
25	7
26		-	// Remove tseslint.configs.recommended and replace with this
27		-	tseslint.configs.recommendedTypeChecked,
28		-	// Alternatively, use this for stricter rules
29		-	tseslint.configs.strictTypeChecked,
30		-	// Optionally, add this for stylistic rules
31		-	tseslint.configs.stylisticTypeChecked,
	8	+	## Roadmap
32	9
33		-	// Other configs...
34		-	],
35		-	languageOptions: {
36		-	parserOptions: {
37		-	project: ['./tsconfig.node.json', './tsconfig.app.json'],
38		-	tsconfigRootDir: import.meta.dirname,
39		-	},
40		-	// other options...
41		-	},
42		-	},
43		-	])
44		-	```
45		-
46		-	You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
47		-
48		-	```js
49		-	// eslint.config.js
50		-	import reactX from 'eslint-plugin-react-x'
51		-	import reactDom from 'eslint-plugin-react-dom'
52		-
53		-	export default defineConfig([
54		-	globalIgnores(['dist']),
55		-	{
56		-	files: ['*/.{ts,tsx}'],
57		-	extends: [
58		-	// Other configs...
59		-	// Enable lint rules for React
60		-	reactX.configs['recommended-typescript'],
61		-	// Enable lint rules for React DOM
62		-	reactDom.configs.recommended,
63		-	],
64		-	languageOptions: {
65		-	parserOptions: {
66		-	project: ['./tsconfig.node.json', './tsconfig.app.json'],
67		-	tsconfigRootDir: import.meta.dirname,
68		-	},
69		-	// other options...
70		-	},
71		-	},
72		-	])
73		-	```
	10	+	- [ ] Mark posts as read/unread
	11	+	- [ ] Import/Export OPML
	12	+	- [ ] Import/Export account through mnemonic
	13	+	- [ ] Refresh/Update Feeds
	14	+	- [ ] Tweakcn theme switching