diff --git a/apps/web/README.md b/apps/web/README.md index 7dbf7ebf..ed8c987f 100644 --- a/apps/web/README.md +++ b/apps/web/README.md @@ -1,73 +1,32 @@ -# React + TypeScript + Vite +# DevCard Web Platform -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +This is the informational web platform for DevCard, built with React, TypeScript, and Vite. +It serves as the main landing page to guide users and contributors to our community, github repository, and mobile app. -Currently, two official plugins are available: +## Running Locally -- [@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/) +To run the web application locally: -## 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 +```bash +npm run dev +``` -If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules: +## Testing -```js -export default defineConfig([ - globalIgnores(['dist']), - { - files: ['**/*.{ts,tsx}'], - extends: [ - // Other configs... +This project uses Vitest and React Testing Library for testing. - // 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, +To run the tests: - // Other configs... - ], - languageOptions: { - parserOptions: { - project: ['./tsconfig.node.json', './tsconfig.app.json'], - tsconfigRootDir: import.meta.dirname, - }, - // other options... - }, - }, -]) +```bash +npm run test ``` -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: +## Contributing + +The web app is a simple, clean, and informative landing page. If you'd like to add sections or improve the UI, make sure you maintain the minimal and professional design aesthetic. -```js -// eslint.config.js -import reactX from 'eslint-plugin-react-x' -import reactDom from 'eslint-plugin-react-dom' +If you are developing a production application, you can build it with: -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... - }, - }, -]) +```bash +npm run build ``` diff --git a/apps/web/index.html b/apps/web/index.html index 5b8a1613..7952d5fe 100644 --- a/apps/web/index.html +++ b/apps/web/index.html @@ -1,15 +1,20 @@ -
- - - - - -