feat: using aliases

Author: anyulled

README.md

@@ -34,6 +34,27 @@ The project follows a standard React application structure:
     - `2024/`: Components specific to the 2024 conference edition
     - `2023/`: Components specific to the 2023 conference edition
 
+## Path Aliases
+
+This project uses path aliases to simplify imports. Instead of using relative
+paths like `../../components/Button`, you can use aliases like
+`@components/Button`.
+
+Available aliases:
+
+- `@components/*` - Components from `src/components/`
+- `@constants/*` - Constants from `src/constants/`
+- `@services/*` - Services from `src/services/`
+- `@hooks/*` - Hooks from `src/hooks/`
+- `@assets/*` - Assets from `src/assets/`
+- `@styles/*` - Styles from `src/styles/`
+- `@views/*` - Views from `src/views/`
+- `@utils/*` - Utilities from `src/utils/`
+- `@data/*` - Data from `src/data/`
+- `@types/*` - Types from `src/types/`
+
+For more details, see the [Path Aliases Documentation](docs/path-aliases.md).
+
 ## Development Workflow
 
 ### Getting Started
@@ -50,21 +71,23 @@ The project follows a standard React application structure:
 - `npm run test-coverage`: Run tests with coverage reporting
 - `npm run build`: Build for production
 - `npm run deploy`: Deploy to GitHub Pages
-- `npm run eject`: Eject from Create React App (not recommended)
+- `npm run lint`: Run ESLint to check for code quality issues
+- `npm run lint:fix`: Run ESLint and automatically fix fixable issues
 
 ## Contribution Guidelines
 
 When contributing to this project, please:
 
 1. Follow the existing code style and patterns
-2. Write tests for new features
-3. Ensure all tests pass before submitting pull requests
-4. Keep the UI consistent with the existing design
-5. Document any new components or significant changes
+2. Run ESLint (`npm run lint`) to ensure code quality and fix any issues
+3. Write tests for new features
+4. Ensure all tests pass before submitting pull requests
+5. Keep the UI consistent with the existing design
+6. Document any new components or significant changes
 
 ## Contact
 
 For questions or issues related to the DevBcn website, please open an issue in
 this repository.
 
-Visit the live site at [https://www.devbcn.com](https://www.devbcn.com)
+Visit the live site at [https://www.devbcn.com](https://www.devbcn.com)