summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAdam Malczewski <[email protected]>2026-03-10 17:09:21 +0900
committerAdam Malczewski <[email protected]>2026-03-10 17:09:21 +0900
commit763eee4f77f5cae114be10e22b257c6c9428bf96 (patch)
treef3d325180ae68f0b1938ea7bec17784936b5c185
parente7c69ea6f7358e78acad36eca99c96eeeed096ce (diff)
downloadtirecalc-763eee4f77f5cae114be10e22b257c6c9428bf96.tar.gz
tirecalc-763eee4f77f5cae114be10e22b257c6c9428bf96.zip
ls
-rw-r--r--README.md76
1 files changed, 12 insertions, 64 deletions
diff --git a/README.md b/README.md
index d2e7761..722df19 100644
--- a/README.md
+++ b/README.md
@@ -1,73 +1,21 @@
-# React + TypeScript + Vite
+# Bicycle Wheel Circumference
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+A small learning app (React + TypeScript + Vite) to measure bicycle wheel circumference by rolling the wheel or by entering diameter. This project is a port of the tire size calculator that once lived on the Cateye website but was removed. It was reimplemented here for usefulness and learning.
-Currently, two official plugins are available:
+## Quick start
-- [@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
+- Build:
+ docker compose build
-## React Compiler
+- Start (detached):
+ docker compose up -d
-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).
+- Stop and remove containers/networks:
+ docker compose down
-## Expanding the ESLint configuration
+Served on port 5173 — open http://127.0.0.1:5173 or http://localhost:5173
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+## Tech
-```js
-export default defineConfig([
- globalIgnores(['dist']),
- {
- files: ['**/*.{ts,tsx}'],
- extends: [
- // Other configs...
+React - TypeScript - Vite - TailwindCSS - DaisyUI - Docker
- // 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,
-
- // 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...
- },
- },
-])
-```