Open Sourcing Your Stuff

How to create an Open Source JavaScript Library

Kent C. Dodds

Utah

wife, 4 kids, & a dog

PayPal, Inc.

@kentcdodds

kcd.im/oss-stuff-feedback

Please Stand...

@kentcdodds

if you are able ❤️ ♿️

kcd.im/oss-stuff-feedback

What this talk is

• Identifying a good candidate in a project for open sourcing
• Extracting it to a solid open source project
• Pushing the library to a GitHub org
• Publishing the library on npm
• Replacing the custom project code with a library dependency

@kentcdodds

kcd.im/oss-stuff-feedback

What this talk is not

• An explanation of all of the benefits of open sourcing
• Everything you need to know to maintain an open source project

@kentcdodds

kcd.im/oss-stuff-feedback

Let's get started...

kcd.im/oss-stuff-feedback

codesandbox.io/s/q3ov3wo684

Identify the component

for open sourcing

kcd.im/oss-stuff-feedback

Create the new Project

kcd.im/oss-stuff-feedback

npm init

create your package.json

kcd.im/oss-stuff-feedback

Copy the needed files

from your project

kcd.im/oss-stuff-feedback

npm publish

kcd.im/oss-stuff-feedback

npm install

and add the module dep

kcd.im/oss-stuff-feedback

Create the GitHub repo

kcd.im/oss-stuff-feedback

Create the git repo

git init && git remote

kcd.im/oss-stuff-feedback

Community

You are not an island

ESLint & Jest

setup your project's tests

kcd.im/oss-stuff-feedback

Build

Write modern JS!

kcd.im/oss-stuff-feedback

CI

Run tests, linting, and build for every PR

kcd.im/oss-stuff-feedback

done!

kcd.im/oss-stuff-feedback