Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.26 KB

README.md

File metadata and controls

51 lines (36 loc) · 2.26 KB

Example Implementations

This directory contains reference implementations that demonstrate Bayat's development conventions in action.

Available Examples

Example Description Tech Stack Conventions Demonstrated
Bayat API Starter Production-ready API starter kit Node.js, Express, TypeScript API design, testing, documentation
Bayat React Frontend Frontend application template React, TypeScript, Redux Component structure, state management, accessibility
Bayat Full-Stack App Complete full-stack application React, Node.js, PostgreSQL End-to-end architecture, deployment, CI/CD
Bayat Microservices Demo Microservices architecture demo Node.js, Go, Kubernetes Microservices, containerization, API gateway
Bayat ML Pipeline Machine learning pipeline Python, TensorFlow, MLflow MLOps, data engineering, model deployment

Using These Examples

These example repositories are designed to be used as:

  1. Learning Resources: Study the code to understand how conventions are applied
  2. Project Templates: Fork and use as a starting point for new projects
  3. Reference Implementations: Refer to when making architectural decisions

Contributing Examples

If you'd like to contribute a new example implementation:

  1. Follow the Contribution Guidelines
  2. Use the Project Template guidelines
  3. Ensure your example demonstrates multiple conventions
  4. Include thorough documentation and testing

Requesting New Examples

If you'd like to see an example implementation for a specific technology or pattern:

  1. Open an issue with the label "example-request"
  2. Describe what you'd like to see demonstrated
  3. Explain how it would be useful to the team

Keeping Examples Updated

Example repositories are reviewed and updated quarterly to ensure they remain aligned with the latest conventions and best practices.