Welcome to Node Experience!
Basic Description
Hello! NExp (Node Experience) is a boilerplate for Node, which makes use of a Hexagonal architecture, in addition to all the power of TypeScript that combined allow a perfect cohesion thus achieving a clean and at the same time very powerful implementation.
Each module is divided by business domain:
- App
- AuthHelper
- File
- Item
- Notification
- Role
- User
There are also two particular cases:
- Config
- Shared
The directory structures for business domains are as follows:
Folder structure of a module
├── Domain
│ ├── Entities
│ ├── Exceptions
│ ├── Payloads
│ ├── Services
│ └── UseCases
├── Infrastructure
│ ├── Repositories
│ ├── Schema
│ └── Seeds
├── InterfaceAdapters
├── Presentation
│ ├── Commands
│ ├── Controllers
│ ├── Criterias
│ ├── Exceptions
│ ├── Handlers
│ ├── Middlewares
│ ├── Requests
│ └── Transformers
├── Tests?> Tip I know it may sound repetitive, but it is not a framework. NExp is a set of tools or libraries working together through a common structure. All structural code within this project is not fixed and can be changed freely.
Advantages
The advantages of using this boilerplate is to save time thinking about certain basic structures common to any project to make an API without having to create everything from scratch.
As it is only a boilerplate, you have the freedom to structure the code whatever you want.
Common structures found within this project are:
- Basic authentication and authorization
- Filesystem with minIO, 100% S3 compatible
- Basic push Notification and Email
- TypeORM and Mongoose Integration with a DatabaseFactory
- Express and Koa integration with AppFactory
- Business logic independent of the HTTP and persistence libraries.
- Parcel compiler.
Docs
Postman Documentation
Boilerplate Documentation
License
NExp is MIT licensed.