Penguin.js

Architect an express.js application

Installation

from npm

npx penguin YOUR_PROEJECT_NAME

from git

git clone --depth 1 https://github.com/samayun/penguin.js.git YOUR_PROEJECT_NAME

cd YOUR_PROEJECT_NAME

Commands and Usage

# clone repository & navigate project

# Copy .env.example to .env
 cp .env.example .env

# Build container image
 make build

# Run containers
 make logs

Check List

➡️ Architechture

• ✅ Modular way
• ✅ Monolithic - Layered Architechture (3 Tier, actually 2 tier implemented here)

➡️ Design Patterns

• ✅ MVC - Model View Controller
• ✅ Singleton Pattern- global sharable instance suppose one database in whole application
• ✅ Facade Pattern - multiple database connection with same functionality
• ✅ Service Repository Pattern

➡️ Languages/Framework/Library

• Language: ↪️ Node.js as JS server side runtime
• Framework: ↪️ Express.js as web framework
• Database: ↪️ MongoDB as NoSQL Database
• Documentation: ↪️ Swagger-AutoGen

➡️ Virtualization

• Build Container by Docker : make build or sudo docker-compose up --build --detach
• Run Container by Docker: make logs