862055 - [MakeAPI] Should be requireable via node

Status: RESOLVED FIXED

(Webmaker Graveyard :: MakeAPI, defect, P1)

Description

[Matthew Schranz [:mjschranz]]

Currently we are just having it as a client-side script to flesh out the API bits. However we eventually want this also to be capable of running server side so our tools can connect in an use it for things such as adding project metadata to the makes when created etc.

Comment 1

[Chris DeCairos (:cade)]

Maybe the lib that interacts with the MakeAPI server [1] should be in a separate git repo that can be set as a dependency in other projects. They won't want all of the code that acts on the server side of things.

1. https://github.com/mozilla/MakeAPI/blob/2110133ccdff81b3bd1a691fe8b078e2de3da1ac/public/js/make-client.js

Comment 2

[Jon Buckley]

Nah, you don't need go that far. You can choose what files you want to publish on npm; you just need to figure out a good way to depend on browser code or npm code.

Comment 3

[Matthew Schranz [:mjschranz]]

Attachment: https://github.com/mozilla/MakeAPI/pull/7

I can't say for sure that this is the best way to do it but it definitely is functional. Let me know if there's something glaring about this.

Comment 4

[Simon C. Wex]

I'd have a look at: http://requirejs.org/. This specific use is one of the goals of require.js.

Comment 5

[Chris DeCairos (:cade)]

Comment on attachment 738144 [details] [review]
https://github.com/mozilla/MakeAPI/pull/7

I left a comment in the pull request.

Comment 6

[Matthew Schranz [:mjschranz]]

Landed as:

https://github.com/mozilla/MakeAPI/commit/3dfa5f150dc21f0b3e58601b13d73e3f51352293
https://github.com/mozilla/MakeAPI/commit/572d5c87e61cd75d313163d6942f143c02d727d9
https://github.com/mozilla/MakeAPI/commit/5340450aa8357345d1e53b556053c723be4e3c4c

Chris, do you want to file a separate ticket to fix the comment you left?

Comment 7

[Chris DeCairos (:cade)]

guess I'll have to.

Comment 8

[Chris DeCairos (:cade)]

Matt is this good to close? 

Also, I filed Bug 862895