https://github.com/sanchit0496/nodejs_scaffolding

This repository serves as a comprehensive starting point for building scalable, efficient, and robust Node.js applications. Tailored for rapid development and production readiness, it includes a suite of tools and configurations to kickstart any Node.js project, focusing on best practices, security, and performance
https://github.com/sanchit0496/nodejs_scaffolding

Last synced: about 5 hours ago
JSON representation

This repository serves as a comprehensive starting point for building scalable, efficient, and robust Node.js applications. Tailored for rapid development and production readiness, it includes a suite of tools and configurations to kickstart any Node.js project, focusing on best practices, security, and performance

• Host: GitHub
• URL: https://github.com/sanchit0496/nodejs_scaffolding
• Owner: sanchit0496
• Created: 2024-01-06T11:48:58.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-14T21:54:49.000Z (10 months ago)
• Last Synced: 2024-01-15T06:27:09.000Z (10 months ago)
• Language: JavaScript
• Size: 198 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Node.js Microservice Architecture

This repository contains a Node.js application implementing a microservice architecture with Sequelize ORM, Apache Kafka for Messaging, Redis for Caching, Swagger for Documentation, JOI for Validation, and Winston for Logging. The application is structured as a scaffolding to kickstart Node.js-based microservice projects.

## Features

- **Express**: Web framework for Node.js.

- **KafkaJS**: Kafka client for Node.js, used for handling event-driven messaging between services.

- **ioredis**: Redis client for Node.js, used for caching data efficiently.

- **Winston**: A logger for just about everything, with `winston-daily-rotate-file` for log rotation.

- **Sequelize**: Promise-based Node.js ORM for MySQL.

- **MySQL**: Used for data persistence.

- **Swagger**: Used for documenting APIs on server.

- **JOI**: Used for validating incoming requests APIs on server.

- **PM2**: Widely-used process manager for Node.js applications, known for its ability to keep applications alive indefinitely, reload them without any hurdle.

- **Nodemon**: Utility that monitors for any changes in your source and automatically restarts your server.

### Prerequisites

Before running this application, ensure you have the following installed:

- Node.js

- MySQL

- Apache Kafka and ZooKeeper

- Redis

## How To Install and Run Kafka 

-**Download Kafka:** https://downloads.apache.org/kafka/3.6.1/kafka_2.12-3.6.1.tgz

-**Download Zookeeper:** https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.8.3/apache-zookeeper-3.8.3-bin.tar.gz 

zookeeper-server-start.bat ..\..\config\zookeeper.properties

kafka-server-start.bat ..\..\config\server.properties

kafka-topics.bat --create --topic my-topic --bootstrap-server localhost:9092 --replication-factor 1 --partitions 3 (This is required only when you initialize the topic)

kafka-console-producer.bat --broker-list localhost:9092 --topic my-topic

kafka-console-consumer.bat --bootstrap-server localhost:9092 --topic my-topic --from-beginning

## How to Install and Run Redis

-**Download Redis:** https://github.com/redis/redis/archive/7.2.4.tar.gz

wsl --install

wsl -l -v

curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list

sudo apt-get update

sudo apt-get install redis

sudo service redis-server start

redis-cli