Building A Popular Open-Source javascript Library

Slide 1

Slide 1 text

BUILDING A POPULAR OPEN-SOURCE JAVASCRIPT LIBRARY BEST PRACTICES AND LESSONS LEARNED

Slide 2

Slide 2 text

JAMES SMITH loopj loopj

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

WHAT IS A LIBRARY?

Slide 5

Slide 5 text

WHY SHOULD I BUILD A LIBRARY?

Slide 6

Slide 6 text

CREATING A LIBRARY

Slide 7

Slide 7 text

USE A LIBRARY BOILERPLATE http://yeoman.io

Slide 8

Slide 8 text

YEOMAN GENERATORS https://github.com/randylien/generator-react-gulp-browserify https://github.com/babel/generator-babel-boilerplate https://github.com/jvandemo/generator-angularjs-library

Slide 9

Slide 9 text

WRITE THE CODE MINIMIZE DEPENDENCIES ENCAPSULATION REUSABLE FUNCTIONS/CLASSES

Slide 10

Slide 10 text

TESTING YOUR LIBRARY

Slide 11

Slide 11 text

WRITE AND USE UNIT TESTS https://mochajs.org

Slide 12

Slide 12 text

RUN YOUR TESTS AUTOMATICALLY https://travis-ci.org

Slide 13

Slide 13 text

DOCUMENT YOUR LIBRARY

Slide 14

Slide 14 text

README.MD CODE DOCUMENTATION EXAMPLE APPS

Slide 15

Slide 15 text

“SPEND AS MUCH TIME WRITING DOCUMENTATION AS YOU DO WRITING CODE”

Slide 16

Slide 16 text

PUBLISH YOUR LIBRARY http://bower.io

Slide 17

Slide 17 text

TELL THE WORLD - GET FEEDBACK

Slide 18

Slide 18 text

REDDIT.COM/R/JAVASCRIPT JAVASCRIPT SUBREDDIT

Slide 19

Slide 19 text

NEWS.YCOMBINATOR.COM HACKER NEWS

Slide 20

Slide 20 text

JAVASCRIPTWEEKLY.COM JAVASCRIPT WEEKLY

Slide 21

Slide 21 text

FURTHER READING https://egghead.io/series/how-to-write-an-open-source-javascript-library