Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamesbrel/node_clean_and_modular_arch
Clean, modular architecture is a particularly interesting concept... for a project that is structured, maintainable and scalable without a hitch...
https://github.com/jamesbrel/node_clean_and_modular_arch
clean-architecture express inversify inversify-express javascript modularization nodejs typescript
Last synced: about 2 months ago
JSON representation
Clean, modular architecture is a particularly interesting concept... for a project that is structured, maintainable and scalable without a hitch...
- Host: GitHub
- URL: https://github.com/jamesbrel/node_clean_and_modular_arch
- Owner: JamesBrel
- License: mit
- Created: 2024-02-02T12:59:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-05-29T01:00:03.000Z (7 months ago)
- Last Synced: 2024-05-29T15:07:16.934Z (7 months ago)
- Topics: clean-architecture, express, inversify, inversify-express, javascript, modularization, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 70.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Node Server : Clean and Modular Architecture
### Author : James Brel
### Contact : [email protected]
---
---
## Architecture
the architecture of each feature is based on the clean architecture of Uncle Bob which is constituted mainly of 3 layers :
- Data
- Domain
- Controllers
```
📦features
┗ 📂say_hello_to_world
┃ ┣ 📂controllers
┃ ┣ 📂data
┃ ┗ 📂domain
```
## General Folder Structure Tree
```
📦project
┣ 📂.vscode
┃ ┗ 📜settings.json
┣ 📂envs
┃ ┣ 📜dev.env
┃ ┣ 📜prod.env
┃ ┗ 📜staging.env
┣ 📂lib
┃ ┣ 📂src
┃ ┃ ┣ 📂core
┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┣ 📜inversify.config.ts
┃ ┃ ┃ ┃ ┣ 📜middle.config.ts
┃ ┃ ┃ ┃ ┗ 📜server.config.ts
┃ ┃ ┃ ┗ 📜init.ts
┃ ┃ ┣ 📂modules
┃ ┃ ┃ ┗ 📂hello_mod
┃ ┃ ┃ ┃ ┗ 📂features
┃ ┃ ┃ ┃ ┃ ┗ 📂say_hello_to_world
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂controllers
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜say_hello_to_world_controller.ts
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂data
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂data_source
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂impls
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜hello_to_world_impl.ts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂interfaces
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜hello_to_world_inter.ts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂models
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂reposit_impls
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜system_greet_the_world_reposit_impl.ts
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂domain
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂entities
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂reposit_interfaces
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜system_greet_the_world_reposit_inter.ts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂usecases
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜say_hello_word_usecase.ts
┃ ┃ ┗ 📂shared
┃ ┃ ┃ ┣ 📂constants
┃ ┃ ┃ ┃ ┣ 📜api.const.ts
┃ ┃ ┃ ┃ ┣ 📜number.const.ts
┃ ┃ ┃ ┃ ┣ 📜string.const.ts
┃ ┃ ┃ ┃ ┗ 📜version.const.ts
┃ ┃ ┃ ┣ 📂extensions
┃ ┃ ┃ ┣ 📂global
┃ ┃ ┃ ┃ ┗ 📜string.variable.ts
┃ ┃ ┃ ┣ 📂logs
┃ ┃ ┃ ┃ ┗ 📜logger.ts
┃ ┃ ┃ ┣ 📂middlewares
┃ ┃ ┃ ┗ 📂services
┃ ┃ ┃ ┃ ┣ 📂images
┃ ┃ ┃ ┃ ┗ 📂security
┃ ┗ 📜index.ts
┣ 📂test
┃ ┗ 📜.gitkeep
┣ 📜.eslintignore
┣ 📜.eslintrc
┣ 📜.gitignore
┣ 📜.prettierignore
┣ 📜.prettierrc
┣ 📜babel.config.json
┣ 📜jest.config.json
┣ 📜nodemon.json
┣ 📜package.json
┣ 📜readme.md
┣ 📜tsconfig.json
┗ 📜typedoc.json
```
## Usage and Configuration
After downloading or cloning the Git Repository
1. go to the **project** folder and copy all the content in your server's project
2. go into your **package.json file**, fill the following points:
- "name" : Specify the Project Name
- "description" : Specify the Project Description
- "url" : "git+url" (complete the url line with the git url of your repository)
- "author" : Specify the Project Author (Organisation name)
3. and type ***npm install*** to install all packages of Dependencies and Dev_Dependencies
---
Copyright © 2024 James Brel All Rights Reserved