Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
JaveedIshaq committed Dec 15, 2024
1 parent 3dcc6cd commit 9b0cd1c
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,26 @@ Before you begin, ensure you have the following installed:

2. **Install dependencies**
```bash
npm install
npm install --legacy-peer-deps
```
### Important Notes on Configuration

#### Using --legacy-peer-deps
We use `npm install --legacy-peer-deps` because Angular 19 has strict peer dependency requirements. This flag allows us to:
- Install packages with peer dependency conflicts
- Maintain compatibility with packages that haven't yet updated to support Angular 19
- Work around the dependency conflict between @angular-builders/custom-webpack and Angular 19

#### Custom Webpack Configuration
The [custom-webpack.config.js](cci:7://file:///Users/javeedishaq/devwork/ng-dev-folio/custom-webpack.config.js:0:0-0:0) is essential because:
1. Angular 19 doesn't natively support `.env` files for environment variables
2. We use `dotenv-webpack` plugin to:
- Load environment variables from `.env` files
- Access these variables using `process.env` in our application
- Keep sensitive information like API keys secure
- Support different configurations for development and production

This setup allows us to maintain secure and flexible environment configurations while working with Angular 19's architecture.

3. **Set up environment variables**
- Create a `.env` file in the root directory
Expand Down

0 comments on commit 9b0cd1c

Please sign in to comment.