Enterprise Node - Code Discoverability
Download as PPTX, PDF1 like264 views
The document outlines the importance of code discovery in enterprise software, emphasizing benefits such as preventing code duplication and improving documentation and cross-team communication. It details best practices for defining APIs, naming conventions, and the use of semantic versioning, as well as various tools and registries for managing packages. It also references multiple webinars on enterprise Node.js topics, highlighting its growing preference over other technologies like Java and Ruby.
Enterprise Node - Code Discoverability
- 2. ABOUT ME Tech Lead @ MLS Medium: @kurtiskemple Twitter: @kurtiskemple GitHub: @kkemple
- 3. REPO FOR THIS WEBINAR KKEMPLE/AWESOME-ENTERPRISE-WEB-SERVICE
- 4. WHY IS CODE DISCOVERY IMPORTANT?
- 5. BENEFITS • Prevents Code Duplication • Improves Documentation Processes • Improves Cross-team Communication
- 7. DEFINING APIS • Naming Conventions Should be Intuitive • The API Should be as Simple As Possible (jQuery) • The API Should be First Level of Documentation
- 8. PACKAGE NAMING CONVENTIONS • Naming Conventions Should be Intuitive (<org>.UI.components.forms) • Naming Conventions Should be Consistent • Naming Conventions Should be Descriptive
- 9. DOCUMENTATION • Anything Public Should be Documented • Provide Example Usages • The More Information You Provide About What and Why the Better • Types Are a Form of Documentation (Flow, Typescript)
- 10. SEMVAR (SEMANTIC VERSIONING) • Allows for Individual Updates • Helps Show Maturity of Module • Forces Thought Into Updates
- 11. STORING PACKAGES
- 12. SINOPIA • Open Source Private Registry • Caches NPM Modules • Ability to Whitelist/Blacklist Modules • Search • https://www.npmjs.com/package/sinopia
- 13. NPM ENTERPRISE • Enterprise Private Registry • Caches Public NPM Modules • Ability to Whitelist/Blacklist Modules • Advanced Search and Dashboard • https://www.npmjs.com/enterprise
- 14. ARTIFACTORY (JFROG) • Private Registry + Other Artifact Storage • Caches Public NPM Modules • Ability to Whitelist/Blacklist Modules • Advanced Search and Dashboard • https://www.jfrog.com/artifactory/
- 15. INTEGRATING CODE DISCOVERY INTO YOUR WORKFLOW
- 16. JS INSPECT
- 17. CODE CLIMATE - DUPLICATION ENGINE
- 18. SWAGGER API DOCS
- 19. JS DOC
- 20. RTYPE
- 21. FLOW
- 22. SEMANTIC-RELEASE
- 23. Q&A
- 24. • Enterprise Node.js - Code Quality https://www.crowdcast.io/e/enterprise-node-1 • Enterprise Node.js - Code Discovery https://www.crowdcast.io/e/enterprise-node-2 • Enterprise Node.js - Securing Your Environment https://www.crowdcast.io/e/enterprise-node-3 • Enterprise Node.js - Deploying with Docker https://www.crowdcast.io/e/enterprise-node-4 24 ENTERPRISE NODE.JS
- 25. JavaScript is replacing Java, Ruby, and .NET as the technology of choice for companies that want to build enterprise software faster, and with fewer resources. Learn about enterprise JavaScript applications at every level of the stack. As well as how to secure, integrate, test, store, monitor, and deploy them. O’REILLY SOFTWARE ARCHITECTURE CONFERENCE Architecting For Enterprise in Node.js