Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/baguilar6174/node-natours-server

This repository contains a Rest API server created with Node, Express and Typescript, using clean architecture and best development practices. It uses MongoDB DB.
https://github.com/baguilar6174/node-natours-server

docker docker-compose eslint express hexagonal-architecture mongo mongoose node prettier typescript

Last synced: about 2 months ago
JSON representation

This repository contains a Rest API server created with Node, Express and Typescript, using clean architecture and best development practices. It uses MongoDB DB.

Awesome Lists containing this project

README 

        
# Natours Server



This repository contains a Rest API server created with Node, Express and Typescript, using clean architecture and best development practices. It uses MongoDB DB.



## Hexagonal Architecture (Ports & Adapters) and DDD



The hexagonal architecture seeks to separate the business logic from the user interface and in turn from the external infrastructure. To do so, we divide the application into three main layers:



### Domain



A layer that is the most internal of all, (core of the application). Here are the essential components and modules that execute the main functions of the software. This central part is responsible for coordinating and managing the interactions between the various layers and elements of the system, ensuring efficiency, scalability and stability of the application.



**Important**: in this layer, the logic of the necigio is defined (DEFINITION != IMPLEMENTATION)



### Application



It is the one that contains the implementation of the services and the business logic.



### Infraestructure



It is the most external layer of all, where it connects with external applications, databases, API Rest, etc.



  

    

  



**Important**: The innermost layers cannot depend on external layers (dependency inversion principle). In other words, the domain layer cannot depend on any other layer. In turn, the application layer cannot depend on the infrastructure layer and must only communicate with the domain layer through ports.



- **Ports**: are used as communication bridges between the different layers of the application.

- **Adapters**: are used as external communication bridges for the application (other applications, external services, etc.). The adapters are located in the infrastructure layer.



**You can read more about this implementation in [docs folder](./docs/)**



## Installation



This project was generated with [Express](https://expressjs.com/)



Clone this repository



```bash

git clone https://github.com/baguilar6174/node-natours-server.git

```



Install dependencies



```bash

yarn

```



## Running the app



If you need local mongo database



- Install docker

- Run `docker-compose up -d` This command create a local volumen in root project to save data.



**Important**: If you don't need mongo from Docker or if you decide to use some different email client, set your configuration into `.env` file. Mi `docker-compose.yaml` create two containers:



1. **Mongo Database**: the volume of this database is allocated in the root of your project `./mongo` if you delete this folder you'll lose your data.

2. **Mailhog Server**: this client allow you to send emails in to local machine. You can view the email inbox at [http://localhost:8025/](http://localhost:8025/)



- Rename `.env.template` to `.env` and add your environment variables

- Run `yarn dev`



If your want to create build production, run `yarn build`



## My process



### Built with



- Node

- Express

- Typescript

- MongoDB & Mongoose

- Eslint & Prettier



### What I learned



- Fundamentals of Express (Node.js framework): routing, middleware, sending responses, etc.

- RESTful API design and development with advanced features: filtering, sorting, aliasing, pagination

- CRUD operations with MongoDB and Mongoose

- Fundamentals of Mongoose (MongoDB JS driver): Data models, CRUD operations, data validation, and middleware

- Using clean architecture

- How to work with data in NoSQL databases

- Use Mongo pipelines

- How to work with data in NoSQL databases (including geospatial data)

- Security: encryption, sanitization, rate limiting, etc.

- Complete modern authentication and authorization with JWT: user sign up, log in, password reset, secure cookies, etc.



## Development Features



- Clean Architecture

- Eslint and Prettier

- Good folder structure

- Complete authentication and authorization module

- Authorization (user roles)

- Security: best practices, encryption, sanitization, rate limiting, etc.



## Improves



- Using repository pattern

- Using object value pattern

- Implements SQL repository

- Include real email client

- Implements a web client to consume this API

- Implement advanced authentication features

  - Confirm user email

  - Keep user logged in with refresh tokens

  - 2FA



## TODO:



- Make responses with same format

- API Documentation

- Alias path

- Verify mailhog with docker compose

- Endpoint to delete and create fake data

- Select neccesary field into relationships

- Remove validation where route uses protect middleware

- Add CORS config



## Natours Server



### Postman Collection



You can see all endpoints in this collection [postman_collection](./docs/postman_collection.json) and the environment variables [postman_environment](./docs/postman_environment.json)



  

    

  



## Stay in touch



- Website - [www.bryan-aguilar.com](https://www.bryan-aguilar.com/)

- Medium - [baguilar6174](https://baguilar6174.medium.com/)

- LinkedIn - [baguilar6174](https://www.linkedin.com/in/baguilar6174)