Quick start guide documentation could be clearer

Topic: Quick start guide documentation could be clearer

Mark Olive pro asked 6 years ago

Following your example to create a new mdb project there are loads of dependency version problems.

ng new testmdb --style=scss

npm install angular-bootstrap-md --save

The angular-bootstrap-md package seems to require 5.1.2 angular, but the 'ng new' installs angular version 5.2.3. It's really messy then trying to downgrade all the dependancies to work with mdbootstrap.

See:https://mdbootstrap.com/angular/5min-quickstart

Step 1: Create new angular project using Angular CLI command:

ng new your-angular-project --style=scss

Step 2:

cd your-angular-project

Step 3: GitHub npm install

npm i angular-bootstrap-md --save

......................

npm WARN angular-bootstrap-md@5.1.2 requires a peer of @angular/animations@5.0.0 - 5.1.2 but none is installed. You must install peer dependencies yourself.

npm WARN angular-bootstrap-md@5.1.2 requires a peer of @angular/common@5.0.0 - 5.1.2 but none is installed. You must install peer dependencies yourself.

npm WARN angular-bootstrap-md@5.1.2 requires a peer of @angular/compiler@5.0.0 - 5.1.2 but none is installed. You must install peer dependencies yourself.

npm WARN angular-bootstrap-md@5.1.2 requires a peer of @angular/core@5.0.0 - 5.1.2 but none is installed. You must install peer dependencies yourself.

npm WARN angular-bootstrap-md@5.1.2 requires a peer of @angular/forms@5.0.0 - 5.1.2 but none is installed. You must install peer dependencies yourself.

npm WARN angular-bootstrap-md@5.1.2 requires a peer of chart.js@2.5.x but none is installed. You must install peer dependencies yourself.

npm WARN angular-bootstrap-md@5.1.2 requires a peer of hammerjs@2.0.x but none is installed. You must install peer dependencies yourself.

npm WARN angular-bootstrap-md@5.1.2 requires a peer of font-awesome@4.7.x but none is installed. You must install peer dependencies yourself.

npm WARN angular-bootstrap-md@5.1.2 requires a peer of @agm/core@~1.0.0-beta.2 but none is installed. You must install peer dependencies yourself.+ angular-bootstrap-md@5.1.2added 2 packages in 26.215s

Add comment

Damian Gemza staff answered 6 years ago

1 0 Best answer

Hello Mark,

It's not our fault, it's way that Angular works.

Let me explain you whole situation:

Our MDB requires version of Angular from 5.0.0 to 5.2.1 as peerDependencies. Against this version our product was tested by us.

Latest version of Angular is 5.2.4. If you type ng new, the CLI creates new project with the latest version of Angular (look at the package.json, for example "@angular/animations": "^5.2.0",) means that version that will be installed will be minimum 5.2.0, but as latest as possible. When you install our library, npm list you warnings that our MDB requires peerDependencies like @angular/forms in versions 5.0.0 - 5.1.2, but on your's project wasn't installed that version. You could repair this, but it's nonsense.

In conclusion: Feel free to use as latest Angular as you want, but our MDB will always be tested with few versions below latest. it's not a critically error, it's just a warning. Please remember, that if you have latest Angular, our MDB should works with it fine. In every update, we popup tested version of Angular to as latest as possible.

Best Regards,

Damian

Please insert min. 20 characters.

Hello Mark, It's not our fault, it's way that Angular works. Let me explain you whole situation: Our MDB requires version of Angular from 5.0.0 to 5.2.1 as peerDependencies. Against this version our product was tested by us. Latest version of Angular is 5.2.4. If you type ng new, the CLI creates new project with the latest version of Angular (look at the package.json, for example "@angular/animations": "^5.2.0",) means that version that will be installed will be minimum 5.2.0, but as latest as possible. When you install our library, npm list you warnings that our MDB requires peerDependencies like @angular/forms in versions 5.0.0 - 5.1.2, but on your's project wasn't installed that version. You could repair this, but it's nonsense. In conclusion: Feel free to use as latest Angular as you want, but our MDB will always be tested with few versions below latest. it's not a critically error, it's just a warning. Please remember, that if you have latest Angular, our MDB should works with it fine. In every update, we popup tested version of Angular to as latest as possible. Best Regards, Damian

Mark Olive pro commented 6 years ago

Thanks, I understand, however this is confusing to a newbie. It would be good if the documentation in the quick start explained that the warnings can be ignored. Otherwise people will think that there is a problem and then spend hours googling for solutions.

Damian Gemza staff commented 6 years ago

Oh, it could be frustrating. Thanks for yours opinion. Well add this to our docs

Add comment

Write

Create snippet

FREE CONSULTATION

Hire our experts to build a dedicated project. We'll analyze your business requirements, for free.

Status

Answered

Specification of the issue

ForumUser: Pro
Premium support: No
Technology: MDB Angular
MDB Version: -
Device: -
Browser: -
OS: -
Provided sample code: Yes
Provided link: No

Mark Olive

Pro User 4Support score
5Questions 0Answers 0Snippets