https://github.com/yesarib/nodejs-project-structer
This project provides a structured template for building Node.js applications. It is designed to help developers organize their project codebase effectively by following a modular architecture.
https://github.com/yesarib/nodejs-project-structer
cli ddd eventdriven hexagonal-architecture microservices nodejs project-structure structure typescript
Last synced: 17 days ago
JSON representation
This project provides a structured template for building Node.js applications. It is designed to help developers organize their project codebase effectively by following a modular architecture.
- Host: GitHub
- URL: https://github.com/yesarib/nodejs-project-structer
- Owner: Yesarib
- Created: 2024-09-27T23:18:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-19T14:39:01.000Z (over 1 year ago)
- Last Synced: 2025-10-30T14:37:44.723Z (3 months ago)
- Topics: cli, ddd, eventdriven, hexagonal-architecture, microservices, nodejs, project-structure, structure, typescript
- Language: TypeScript
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js Project Structure
## Description
This project provides a structured template for building scalable Node.js applications. It follows a modular architecture, promoting code reusability and maintainability. Developers can choose from various templates, each designed for different architectural patterns such as DDD, Event-Driven, and Microservices.
## Installation
To use the project structure templates globally, install the package:
```bash
npm install -g @yesari/nodestruct
```
## Usage
You can create a sample project:
```
npx node-structer create [template] [project-name]
```
### Available Templates:
Each template offers a unique architectural design:
- js-base: A simple, minimal JavaScript structure.
- js-DDD: Domain-Driven Design in JavaScript.
- js-EventDriven: Event-Driven architecture for JS apps.
- js-Hexagonal: Follows Hexagonal architecture principles.
- js-microservices: Microservice-based structure for JS.
- ts-base: Basic TypeScript structure.
- ts-DDD: Domain-Driven Design using TypeScript.
- ts-EventDriven: Event-Driven pattern for TS.
- ts-Hexagonal: Hexagonal architecture in TypeScript.
- ts-microservices: Microservice setup with TS.
### Example:
To create a new project using the JavaScript base template:
```
npx node-structer create js-base demo
```
## Development:
If you want to contribute or make modifications, clone the repository:
1. Clone the repository:
```bash
git clone https://github.com/Yesarib/nodejs-project-structer.git
2. Install dependencies:
```bash
npm install
```
3. Build the project:
```bash
npm run build
```
## License
This project is licensed under the MIT License.
You can modify this as needed for more details or additional instructions!