Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samayun/penguin.js
Penguin is a modern nodejs framework provides common features which helps to develop products rapidly
https://github.com/samayun/penguin.js
clean-architecture docker express express-framework mongodb nodejs nodejs-boilerplate nodejs-framework
Last synced: 27 days ago
JSON representation
Penguin is a modern nodejs framework provides common features which helps to develop products rapidly
- Host: GitHub
- URL: https://github.com/samayun/penguin.js
- Owner: samayun
- License: mit
- Created: 2021-09-06T13:23:42.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T06:17:57.000Z (almost 2 years ago)
- Last Synced: 2023-05-01T02:03:30.201Z (over 1 year ago)
- Topics: clean-architecture, docker, express, express-framework, mongodb, nodejs, nodejs-boilerplate, nodejs-framework
- Language: JavaScript
- Homepage: https://samayun.gitbook.io/architect-express-apps
- Size: 1.92 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Penguin.js
Architect an express.js application
## Installation
#### from npm
```bash
npx penguin YOUR_PROEJECT_NAME
```
#### from git
```bash
git clone --depth 1 https://github.com/samayun/penguin.js.git YOUR_PROEJECT_NAME
cd YOUR_PROEJECT_NAME
```
## Commands and Usage
```bash
# 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](https://nodejs.org/en) as JS server side runtime
- Framework: ↪️ [Express.js](https://expressjs.com) as web framework
- Database: ↪️ [MongoDB](https://www.mongodb.com) as NoSQL Database
- Documentation: ↪️ [Swagger-AutoGen](https://github.com/davibaltar/swagger-autogen)
➡️ Virtualization
- Build Container by Docker : `make build` or `sudo docker-compose up --build --detach`
- Run Container by Docker: `make logs`