emethium / node-functional-boilerplate

A Functional boilerplate inspired in DDD/Clean Architecture for Node web APIs

Node Functional Boilerplate

NodeJS functional boilterplate for microservices

📖 Index

• About
• Features
• Quick start
• Issues
• Constributing
• Built with

🔍 About

Created following the concepts of Functional Programming, Clean Architecture and Domain Driven Development.
Microservice oriented, aiming to provide a quick services development, highly scalable and be resilient to business rules changes.

🎈 Quick start

• Clone this repo using git clone https://github.com/zrpaplicacoes/node-functional-boilerplate.git;
• Move to the appropriate directory: cd node-functional-boilerplate;
• Copy .example.env to .local.env and .docker.env;
• Update environment variables on .local.env to match your host configuration;
• Run npm i in order to install dependencies;
• Docker Only: Run docker-compose up -d app && docker-compose attach app;
• Locally Only: Run Local: Launch on vscode debug tab.
• The sample application will be running in localhost:3000/v1/graphql;
• Happy coding! 🎈

🛠 Issues

Please, if you come across any issues report them here.

Contributing

Anyone is welcome to contribute! Please fell free to make any pull resquests, or resquest features you would like to see in the future.

⛏ Built with

• NodeJS
• ExpressJS
• GraphQL
• MongoDB
• Crocks
• Superstruct
• Docker
• Docker Compose
• Apollo Server
• Mongoose
• Graphql Import
• Awilix
• Morgan
• Nodemon
• Jest
• ESLint
• eslint-plugin-fp