Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thre4dripper/node-server-init
Npm package for initializing node project with custom configurations on the go.
https://github.com/thre4dripper/node-server-init
api cronjob db2 docker express mariadb mongodb mongoose mssql mysql node npm npm-package oracle postgres sequelize socket-io sqlite swagger typescript
Last synced: about 2 months ago
JSON representation
Npm package for initializing node project with custom configurations on the go.
- Host: GitHub
- URL: https://github.com/thre4dripper/node-server-init
- Owner: Thre4dripper
- License: mit
- Created: 2024-01-08T12:50:15.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T14:05:06.000Z (2 months ago)
- Last Synced: 2024-10-22T10:56:51.691Z (2 months ago)
- Topics: api, cronjob, db2, docker, express, mariadb, mongodb, mongoose, mssql, mysql, node, npm, npm-package, oracle, postgres, sequelize, socket-io, sqlite, swagger, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/node-server-init
- Size: 104 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-server-init
Npm package for initializing Node.js server projects with customizable configurations.
## Installation
To use this package, initiate a Node.js server project with custom configurations using the following command:
```bash
npx node-server-init
```
## Usage
If you want to create a Node.js server project with name `my-server`, run the following command:
```bash
npx node-server-init my-server
```
If you want to use current directory as the project folder, run the following command:
```bash
npx node-server-init .
```
## Demo
https://github.com/Thre4dripper/node-server-init/assets/82382156/3eda5aac-ee8f-4ea3-82a1-176f00ee64db
## Features
This npm package provides a flexible setup for Node.js server projects with the following features:
- **Node.js, Express, TypeScript**: Utilizes a robust setup using Node.js, Express, and TypeScript.
- **Sequelize & Mongoose**: Integrations with Sequelize for SQL database operations and Mongoose for MongoDB.
- **Database Compatibility**: Allows interaction with various databases such as MySQL, PostgreSQL, MariaDB, Sqlite,
MSSql, MongoDB.
- **Validation Mechanism**: Built-in validations for incoming request payloads.
- **Automated Swagger Documentation**: Automatically generated API documentation available at `/api-docs`.
- **Service-Based Architecture**: Employs a modular approach for better organization and scalability.
- **Socket Events**: Handles socket event management using Socket.io.
- **Dockerized Deployment**: Supports Docker for easy deployment.
## Project Structure
The project structure is as follows with all configurations:
```
my-server
└───src
├───app
│ ├───apis
│ │ └───user
│ │ ├───controllers
│ │ ├───repositories
│ │ └───services
│ ├───common
│ ├───enums
│ ├───handlers
│ ├───models
│ ├───routes
│ └───utils
└───config
```
## Implementation
Curious about the magic behind this package? 🌟
Wondering where all those files come from? 🧐
The secret sauce is the [NodeTs-Express-Service-Based-Template](https://github.com/Thre4dripper/NodeTs-Express-Service-Based-Template)!
> P. S. I made that too! 😄