diff --git a/README.md b/README.md index 1a8153b..961fd32 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ -# 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) + +--- + +## 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. diff --git a/rappitours/README.md b/rappitours/README.md index da98444..038721d 100644 --- a/rappitours/README.md +++ b/rappitours/README.md @@ -1,54 +1,42 @@ -# 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/) 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 - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules: - -```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, - }, - }, -}) -``` - -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, - }, -}) -``` +
+ +# RappiTours Trails Management App + +This folder contains the source code of the RappiTours Trails Management 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) + +--- + +## 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.