@eliware/project-template

A starter template for new Node.js projects. Use this as a foundation for your next application or service.

---

Table of Contents

• Features
• Getting Started
• Development
• Testing
• Customization
• Support
• License

Features

• Pre-configured for Node.js (ESM)
• Environment variable support via dotenv
• Logging and signal handling via @eliware/common
• Jest for testing
• MIT License

Getting Started

1. Clone this template:

   git clone https://github.com/eliware/project-template.git
   cd project-template
   rm -rf .git
   git init
   npm install

2. Update project details:

   • Edit package.json (name, description, author, etc.)
   • Update this README.md as needed
   • Change the license if required

Development

• Main entry: project-template.mjs

• Start your app:

  node project-template.mjs

• Add your code in new files and import as needed.

Testing

• Run tests with:

  npm test

• Add your tests in the __tests__ folder or alongside your code.

Customization

• Replace or extend the logging and signal handling as needed.
• Add dependencies and scripts to fit your project.
• Remove or modify template files and sections.

Support

For help, questions, or to chat with the author and community, visit:

eliware.org on Discord

License

MIT © 2025 Eli Sterling, eliware.org

Links

• Home Page
• GitHub Repo
• GitHub Org
• GitHub Personal
• Discord