From d6c8138ccd9db067d71bd7b2ed24495a32697207 Mon Sep 17 00:00:00 2001 From: Anon <206556099+An0n-01@users.noreply.github.com> Date: Sun, 25 May 2025 10:44:34 +0200 Subject: [PATCH 1/4] Update README.md --- rappitours/README.md | 70 +++++++++++++++----------------------------- 1 file changed, 23 insertions(+), 47 deletions(-) diff --git a/rappitours/README.md b/rappitours/README.md index da98444..813ca19 100644 --- a/rappitours/README.md +++ b/rappitours/README.md @@ -1,54 +1,30 @@ -# React + TypeScript + Vite +# RappiTours Trails Management App -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +This folder contains the source code of the RappiTours Trails Management App -Currently, two official plugins are available: +## How to Run -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) 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 +1. **Clone this Repository** + ```bash + git clone https://github.com/IMS-coding-projects/M248.git + ``` -## Expanding the ESLint configuration +2. **Enter Folder** + ```bash + cd ./M248/rappitours/ + ``` -If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules: +3. **Install Dependencies (Packages)** + ```bash + npm install --force + ``` +> [!IMPORTANT] +> You need to use the `--force` tag, because of a conflict between the react version and ui.shadcn. For more information, [visit this site](https://ui.shadcn.com/docs/react-19#:~:text=What's,do?) -```js -export default tseslint.config({ - extends: [ - // 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, - ], - languageOptions: { - // other options... - parserOptions: { - project: ['./tsconfig.node.json', './tsconfig.app.json'], - tsconfigRootDir: import.meta.dirname, - }, - }, -}) -``` +4. **Run the Project** + ```bash + npm run dev + ``` -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 tseslint.config({ - plugins: { - // Add the react-x and react-dom plugins - 'react-x': reactX, - 'react-dom': reactDom, - }, - rules: { - // other rules... - // Enable its recommended typescript rules - ...reactX.configs['recommended-typescript'].rules, - ...reactDom.configs.recommended.rules, - }, -}) -``` +5. **Open the Browser** + Unless you manually changed the port, this app will run on [localhost:3000](http://localhost:3000) From 5a5564b4d4e1868993fcff6a60b8e276bb139f48 Mon Sep 17 00:00:00 2001 From: Anon <206556099+An0n-01@users.noreply.github.com> Date: Sun, 25 May 2025 10:51:08 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a8153b..b0268bb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ -# M248 +
-Source Code Repository of M248 + # RappiTours Trails Management App + +This repository contains the source code of the RappiTours Trails Management App +
+ +--- + +## Documentation + +You can find the documentation of this module [**here.**](https://ims-coding-projects.mintlify.app/) + +--- + +## How to Run + +1. **Clone this Repository** + ```bash + git clone https://github.com/IMS-coding-projects/M248.git + ``` + +2. **Enter Folder** + ```bash + cd ./M248/rappitours/ + ``` + +3. **Install Dependencies (Packages)** + ```bash + npm install --force + ``` +> [!IMPORTANT] +> You need to use the `--force` tag, because of a conflict between the react version and ui.shadcn. For more information, [visit this site](https://ui.shadcn.com/docs/react-19#:~:text=What's,do?) + +4. **Run the Project** + ```bash + npm run dev + ``` + +5. **Open the Browser** + Unless you manually changed the port, this app will run on [localhost:3000](http://localhost:3000) From 47dedbb05e6c52fcc5361d99510a595e84fe68d8 Mon Sep 17 00:00:00 2001 From: Anon <206556099+An0n-01@users.noreply.github.com> Date: Sun, 25 May 2025 10:55:09 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b0268bb..961fd32 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,9 @@ You can find the documentation of this module [**here.**](https://ims-coding-pro 5. **Open the Browser** Unless you manually changed the port, this app will run on [localhost:3000](http://localhost:3000) + +--- + +## License + +This project [is licensed](./LICENSE) under the GNU General Public License v3.0. To see what you can do, check out the [LICENSE](./LICENSE) page. From c301583de704ac35ca6f06190604c6225cedf705 Mon Sep 17 00:00:00 2001 From: Anon <206556099+An0n-01@users.noreply.github.com> Date: Sun, 25 May 2025 10:56:18 +0200 Subject: [PATCH 4/4] Update README.md --- rappitours/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/rappitours/README.md b/rappitours/README.md index 813ca19..038721d 100644 --- a/rappitours/README.md +++ b/rappitours/README.md @@ -1,7 +1,13 @@ +
+ # RappiTours Trails Management App This folder contains the source code of the RappiTours Trails Management App +
+ +--- + ## How to Run 1. **Clone this Repository** @@ -28,3 +34,9 @@ This folder contains the source code of the RappiTours Trails Management App 5. **Open the Browser** Unless you manually changed the port, this app will run on [localhost:3000](http://localhost:3000) + +--- + +## License + +This project [is licensed](../LICENSE) under the GNU General Public License v3.0. To see what you can do, check out the [LICENSE](../LICENSE) page.