@bcgov/citz-imb-endpoint-builder

BCGov Express Endpoint Builder

Introduction

This npm package offers a DRY approach to implementing Express API endpoints using a factory design pattern. This reduces the amount of boilerplate code required to implement API endpoints and allows for a more consistent and maintainable codebase.

Get Started Here!

Documentation - Installation, setup and usage guides.

For Developers working on this package:

We emphasize the inclusion of documentation on our code to enhance onboarding efficiency. Understanding the project's architecture and operational dynamics create efficient team members.

We encourage collaboration by making our project's infrastructure transparent and accessible. Enabling developers to easily navigate and contribute to different parts of the codebase without barriers. Enriching our documentation contributes to a self-documenting codebase. The project's structure and commands are defined and updated within the repository itself. Ultimately, making the project more maintainable and scalable over time.

Use the links below to help you understand the codebase better.

• Directory Structure
• Scripts
• Package Management Plan
• Publishing a New Release Version