Here's an marvelous 𧡠thread on ⧩
Beginners π Guide To β¨ Publishing JavaScript Projects π On @npmjs
#100DaysOfCode #JavaScript #TypeScript #CodeNewbie
Continue reading π
Beginners π Guide To β¨ Publishing JavaScript Projects π On @npmjs
#100DaysOfCode #JavaScript #TypeScript #CodeNewbie
Continue reading π
α Deciding Package Name
Finding the right name for your project plays a key role in making it discoverable
It should be π
πΉ Available on GitHub & NPM
πΈ Short and rememberable
πΉ Relevant to the purpose
For the purpose of this thread, I am using a random word "integrated"
Finding the right name for your project plays a key role in making it discoverable
It should be π
πΉ Available on GitHub & NPM
πΈ Short and rememberable
πΉ Relevant to the purpose
For the purpose of this thread, I am using a random word "integrated"
α Creating package.json
Create a new directory and run "npm init -y" in it. This will create a basic package.json file.
Open this file in your favorite code editor and fill in the license, description, and author fields.
π
Create a new directory and run "npm init -y" in it. This will create a basic package.json file.
Open this file in your favorite code editor and fill in the license, description, and author fields.
π
α During Development
While you're working on making your project come to life, keep the version to 0.x.x.
This will π
πΉ Indicate that it's in development
πΈ Lets you push breaking changes
While you're working on making your project come to life, keep the version to 0.x.x.
This will π
πΉ Indicate that it's in development
πΈ Lets you push breaking changes
α Writing Code
You can make a cli app or, a library that runs in the browser or Node.js.
For example, I'll make an app.js and module.export a simple console.log.
Whatever you export from this app.js (or so-called entryfile) will be accessible to users of your library.
π
You can make a cli app or, a library that runs in the browser or Node.js.
For example, I'll make an app.js and module.export a simple console.log.
Whatever you export from this app.js (or so-called entryfile) will be accessible to users of your library.
π
α Setting Project Type
We need to tell npm where is code for our project.
To do that π
πΉ Open package.json
πΈ For lib, add a key "main" and set it to the path of entryfile
πΉ For cli, add a key "bin" and set it to the path of executable
πΈ Adding both is also supported
π
We need to tell npm where is code for our project.
To do that π
πΉ Open package.json
πΈ For lib, add a key "main" and set it to the path of entryfile
πΉ For cli, add a key "bin" and set it to the path of executable
πΈ Adding both is also supported
π
α Login To npmjs
It's time that we publish our project to @npmjs π
Run "npm login" and put in your username, password, and public email address.
This will link npm cli with your npmjs account.
If you don't have an account, creating one is pretty easy!
π
It's time that we publish our project to @npmjs π
Run "npm login" and put in your username, password, and public email address.
This will link npm cli with your npmjs account.
If you don't have an account, creating one is pretty easy!
π
α First Publish
Let's do it! π€ Run the command "npm publish".
This will publish your JavaScript project to npm.
Now anyone can use your project by running π
npm install <project_name>
You'll also get a lovely π email from npm that it's published.
π
Let's do it! π€ Run the command "npm publish".
This will publish your JavaScript project to npm.
Now anyone can use your project by running π
npm install <project_name>
You'll also get a lovely π email from npm that it's published.
π
α Adding Keywords
Once your project is π₯³ published. Time to spread the word about your project!
Re-open package.json & fill the keywords from similar packages. That will get let your project come on searches π
Keywords show during searches & on your package page on npm
π
Once your project is π₯³ published. Time to spread the word about your project!
Re-open package.json & fill the keywords from similar packages. That will get let your project come on searches π
Keywords show during searches & on your package page on npm
π
Special β¨ thanks to @AyushCodes for giving me the idea π‘
Thank you so much! π for reading. If you can follow me, and retweet π this thread to your developer gang, it would be impressive π€©
π
Thank you so much! π for reading. If you can follow me, and retweet π this thread to your developer gang, it would be impressive π€©
π
β’ β’ β’
Missing some Tweet in this thread? You can try to
force a refresh
γ
