search

TemainfoSoftware / truly-ui

Truly-UI - Web Angular UI Components for Desktop Applications (Electron, NW, APP JS)
http://truly-ui.com
Other
215 stars 35 forks source link

Missing doc of Installation #254

Closed longgt closed 5 years ago

longgt commented 5 years ago

Describe the bug Can't start Angular app with Truly-UI.

To Reproduce Following installation, install Truly-UI dependency, add to AppModule and serve.

Expected behavior Truly-UI requires string-format and tl-md5, @angular/cdk as peer dependencies so if this library was not isntalled, ng serve always failed.

Peer dependencies, Angular version should be described as https://github.com/ngx-translate/core (see Installation for more explains)

As Truly-UI is a framework, it should have CHANGELOG file and describe what is BREAKING CHANGES (ex: Angular version...) to help developers in decision whether to upgrade or not.

And it's really amazing if Truly-UI has its own CLI or Starter Kit project.

Versions(environment versions):

welcome[bot] commented 5 years ago

👋 Thanks for opening your first issue here! If you're reporting a 🐞 bug, please make sure you include steps to reproduce it. We get a lot of issues on this repo, so please be patient and we will get back to you as soon as we can. To help make it easier for us to investigate your issue, please follow the contributing guidelines.

abalad commented 5 years ago

We are very happy that you have installed and tested our framework. 👍

About dependencies are not actually installed anymore because NPM removes the peerDependencies auto-install support. Plus I updated the documentation with a step that relates to installing them.

Our project uses Semantic Release, so all changes are listed in the releases link right here on GITHUB, even when there is a BREAKING CHANGES that is listed on each release.

I hope you can use our project more and more because we are still preparing many nice things for him ;)

dyhalmeida commented 5 years ago

@abalad I'm going through the same problem integrating truly into my angular application. How can I solve this?

abalad commented 5 years ago

Tomorrow I'll be sending a new version that will complete the installation. But by the time you just install the dependencies. But for now you can use the guide described here: https://github.com/TemainfoSoftware/truly-ui/tree/develop

abalad commented 5 years ago

A correction was sent to the documentation with the correct explanation of how to perform the installation: http://truly-ui.com/gettingstarted