Skip to content

luismasuarez/npm-module-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📦 Your npm Module Template

Welcome to your new npm module template! 🎉 Here’s a quick guide to get started.

📁 Project Structure

  • /src: Source code
    • index.ts: Entry point
    • starter_example.ts: Example functions
    • types.ts: Type definitions
  • package.json: Project metadata and scripts
  • tsconfig.json: TypeScript configuration
  • tsup.config.ts: Build configuration

✏️ Customization Steps

  1. Edit src/starter_example.ts
    Modify or add functions as needed.

  2. Update src/types.ts
    Define or change types for your module.

  3. Configure src/index.ts
    Export functions and types from this file.

  4. Update package.json
    Set your module’s name, description, and other details.

  5. Build Your Module
    Run npm run build to compile the TypeScript code.

🚀 Publishing Your Module

  1. Login to npm
    If you haven’t logged in yet, run:
    npm login
  2. Publish to npm
    npm publish

Happy coding! 🚀

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published