diff --git a/README.md b/README.md index 9e1f912d..55f45431 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,21 @@ # T03-Project-2 -Repository for team IT2810-H26-T03 in IT2810-H26. +## Overview - I <3 Plants -## Working in this repository +See our full description and specification for the project in the PDF file, **Specifications for project 2.pdf** on git. +You can also open the PDF locally in VS Code with the extention **vscode-pdf**. -`main` is protected — you cannot push to it directly. Work on a branch and -open a pull request: +## Run locally -```bash -git checkout -b my-feature -git push -u origin my-feature -``` +### Requirements -Before a pull request can be merged: +- Node.js v24.6.x or later +- npm v11 or later -1. **A member of IT2810-H26-T03 must approve it.** You cannot approve your own pull - request, and approvals from staff do not count — you review each other's - code. -2. **Every review comment must be marked resolved.** Reply to each one, fix it - or explain why not, then click *Resolve conversation*. -3. **Pushing new commits dismisses the approval**, so if you change something - after being approved, ask for another review. This is deliberate: what was - approved is what gets merged. \ No newline at end of file +### Setup + +- Clone the repo: `git clone ` +- `cd frontend` +- `npm install` +- `npm run dev` + \ No newline at end of file diff --git a/Specifications for project 2_ I _3 Plants.pdf b/Specifications for project 2.pdf similarity index 100% rename from Specifications for project 2_ I _3 Plants.pdf rename to Specifications for project 2.pdf diff --git a/frontend/README.md b/frontend/README.md deleted file mode 100644 index a93c5d9a..00000000 --- a/frontend/README.md +++ /dev/null @@ -1,73 +0,0 @@ -# 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 [Oxc](https://oxc.rs) -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) - -## 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 - -If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules: - -```js -export default defineConfig([ - globalIgnores(["dist"]), - { - files: ["**/*.{ts,tsx}"], - extends: [ - // Other configs... - - // 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://npmx.dev/package/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://npmx.dev/package/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... - }, - }, -]); -```