Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Global and local installation of JavaScript infrastructure #6

Open
hhzl opened this issue Apr 11, 2014 · 11 comments
Open

Global and local installation of JavaScript infrastructure #6

hhzl opened this issue Apr 11, 2014 · 11 comments

Comments

@hhzl
Copy link
Member

hhzl commented Apr 11, 2014

Explain the difference between global and local installation of amber cli (npm), amber front-end (bower) and grunt and the cases why you would want to do it one way or the other.

@ghost
Copy link

ghost commented Apr 11, 2014

You never install amber cli locally. The only use case is
npm install -g amber
(later should be changed to amber-cli).

What you install locally is amber, either for browser project (via bower) or for server-side project (via npm).

Grunt is complicated, but suffices to say it should not be needed at all for the moment for users of amber (only contributors to Amber itself need it).

Herby

Hannes Hirzel wrote:

Explain the difference between global and local installation of amber
cli (npm), amber front-end (bower) and grunt and the cases why you
would want to do it one way or the other.


Reply to this email directly or view it on GitHub
#6.

@hhzl
Copy link
Member Author

hhzl commented Apr 11, 2014

Fine, what about the following draft for an explanation?

To work with amber you need in any case

  1. a node installation see http://www.nodejs.org
  2. a global installation of the Amber command line version which you get with
    npm install -g amber
    (later amber probably will be changed to amber-cli).

If you want to do an amber client side web application you need

   bower  install amber --save

(local installation in your project directory)

In case you want to contribute to the Amber development you need in addition
- git (Version control system)
- grunt
- grunt-init

@ghost
Copy link

ghost commented Apr 11, 2014

Hannes Hirzel wrote:

/Fine, what about the following draft for an explanation?/

To work with amber you need in any case

  1. a node installation see http://www.nodejs.org
  2. a global installation of the Amber command line version which you

s/version /tool /

or

s/version //

get with |npm install -g amber|
(later |amber| probably will be changed to |amber-cli|).

If you want to do an amber client side web application you need

| bower bower install amber --save

Just one bower

|
|

(local installation in your project directory)

In case you want to contribute to the Amber development you need in
addition

I don't know if getting started is the right link (or if give there a link at all).
All that is needed here is

npm install -g grunt-cli

Same here.

The rest is done by 'npm install' in the am
ber git clone (which you need to run anyway).

Herby

@hhzl
Copy link
Member Author

hhzl commented Apr 11, 2014

New draft

To work with amber you need in any case

  1. a node installation see http://www.nodejs.org
  2. a global installation of the Amber command line tool which you get with
    npm install -g amber
    (later amber probably will be changed to amber-cli

If you want to do an amber client side web application which most people do you need create a local project directory and do

   `bower install amber --save`

This does a local installation in your project directory

In case you want to contribute to the Amber development you need in addition

@hhzl
Copy link
Member Author

hhzl commented Apr 11, 2014

@Herby

I did not understand your comment

Same here. The rest is done by `npm install in the amber git clone (which you need to run anyway).

Note:
See also https://github.com/hhzl/grunt-init-amber/blob/master/README.md

@ghost
Copy link

ghost commented Apr 11, 2014

Hannes Hirzel wrote:

/New draft/

To work with amber you need in any case

  1. a node installation see http://www.nodejs.org
  2. a global installation of the Amber command line tool which you get
    with |npm install -g amber| (later |amber| probably will be
    changed to |amber-cli|

If you want to do an amber client side web application which most
people do you need create a local project directory and do

| bower install amber --save
|

This does a local installation in your project directory

In case you want to contribute to the Amber development you need in
addition

  • git (Version control system)
  • grunt |npm install -g grunt-cli| http://gruntjs.com/getting-started
  • grunt-init |npm install -g grunt-cli|
    you meant grunt-init, I presume...
    I would extract the setup for contributing to different page ... it has probably lot more details to solve (how to run tests etc.); it deserves its own page and listing just a su
    bset of it probably isn't worth it.
    http://gruntjs.com/project-scaffolding


Reply to this email directly or view it on GitHub
#6 (comment).

@ghost
Copy link

ghost commented Apr 11, 2014

Hannes Hirzel wrote:

@Herby https://github.com/herby

I did not understand your comment

Same here. The rest is done by `npm install in the amber git clone
(which you need to run anyway).

That's for contributing. If you clone the repo, you need to run
npm install
anyway, to install dependencies, which will install grunt and all.

So no need to care about what needs to be installed locally.

Herby

@hhzl
Copy link
Member Author

hhzl commented Apr 12, 2014

To summarize: The lines of explanation are considerably different for

  1. People who want to use Amber to develop Amber applications
  2. People who wnat to contribute to the development of Amber

@ghost
Copy link

ghost commented Sep 13, 2014

What of this is still an issue? amber init changed the terrain a bit.

@ghost ghost added the enhancement label Sep 14, 2014
@hhzl
Copy link
Member Author

hhzl commented Sep 15, 2014

Yes, let's work on the instructions for 0.13.

It seems that after installing nodejs and npm we only have to do

npm -g install amber-cli
npm install -g requirejs

in 0.13
Correct?

requirejs is needed to get the r.js optimizere

@ghost
Copy link

ghost commented Sep 15, 2014

npm install -g and npm -g install are the same, so just choose what you like and use it consistently in examples.

Second, as r.js got part of standard tooling with last "devel/deploy switch" thing, you don't need to install requirejs unless you want to run it yourself manually (amber uses will be provided via grunt, now they are temporarily accessible via npm run-script).

IOW you need amber-cli only to create, grunt-cli to use the tooling further.and bower (and npm, but that you already have) to play with dependencies . Nothing else should be needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant