Style Guides & Boilerplates

This repository collects opinionated style guides and production‑ready boilerplate projects for multiple stacks.

Each stack provides:

• A style guide (README.md) describing conventions, recommended folder structure, and best practices.
• A boilerplate project that you can clone, copy, or use as a reference when structuring new services and applications.

Available Stacks & Boilerplates

• Flutter

  • Style guide: Flutter/README.md
  • Boilerplates:
    • Default app: Flutter/boilerplate/ (lib/, test/, android/, ios/, ...)
    • MVC app: Flutter/boilerplate_mvc/ (lib/, test/, android/, ios/, ...)

• Python / FastAPI

  • Style guide: Fast API/README.md
  • Boilerplate API service: Fast API/boilerplate/
    • app/ (api/, core/, models/, repositories/, schemas/, services/, workers/)
    • migrations/, tests/, .env.example, pyproject.toml

• Node.js (Express + TypeScript)

  • Style guide: Nodejs/README.md
  • Boilerplate service: Nodejs/boilerplate/
    • src/ (app/, config/, controllers/, lib/, middleware/, models/, repositories/, routes/, services/)
    • .env.example, package.json, tsconfig.json, tests/

• Next.js (App Router)

  • Style guide: Nextjs/README.md
  • Boilerplate app: Nextjs/boilerplate/
    • src/, public/, tests/, next.config.mjs, package.json, tsconfig.json

• React (Vite + TypeScript)

  • Style guide: React/README.md
  • Boilerplate app: React/boilerplate/
    • src/, public/, tests/, package.json, tsconfig.json, vite.config.ts

• Laravel (PHP)

  • Style guide: Laravel/README.md
  • Boilerplate API: Laravel/boilerplate/
    • app/, config/, routes/, tests/

• Shopify Liquid (Online Store 2.0)

  • Style guide: Shopify/README.md
  • Boilerplate theme: Shopify/boilerplate/
    • assets/, config/, layout/, locales/, sections/, snippets/, templates/

• Spring Boot (Java)

  • Style guide: SpringBoot/README.md
  • Boilerplate service: SpringBoot/boilerplate/
    • src/, pom.xml

• AI / ML (Python)

  • Style guide: AI-ML/README.md
  • Boilerplate project: AI-ML/boilerplate/
    • data/ (processed/, raw/), models/, notebooks/ (example.ipynb), src/, tests/, pyproject.toml

• MERN Stack (MongoDB, Express, React, Node.js)

  • Monorepo: MERN/
    • Backend: MERN/backend/ (src/, .env.example, package.json, tsconfig.json)
    • Frontend: MERN/frontend/ (src/, public/, package.json, tsconfig.json, vite.config.ts)

• MEAN Stack (MongoDB, Express, Angular, Node.js)

  • Monorepo: MEAN/
    • Backend: MEAN/backend/ (src/, .env.example, package.json, tsconfig.json)
    • Frontend: MEAN/frontend/ (src/, README.md)

• PERN Stack (PostgreSQL, Express, React, Node.js)

  • Monorepo: PERN/
    • Backend: PERN/backend/ (src/, config/, controllers/, models/, routes/, services/, prisma/, .env.example, package.json, tsconfig.json)
    • Frontend: PERN/frontend/ (src/, public/, package.json, tsconfig.json, vite.config.ts)

Folder names and structure match the repository layout. See each stack's README for details, best practices, and example code.

How to Use

1. Choose a stack folder (for example, Flutter or Nodejs).
2. Read the stack‑specific README to understand conventions, architecture, and tooling.
3. Copy the boilerplate folder into a new project or use it as a reference when structuring an existing codebase.

Contribution Guide

Additions / Changes

• Open an issue describing the proposed change or new guideline.
• Prefix the title with the platform, for example: Nodejs: Error handling patterns.
• Discuss trade‑offs in the issue; once agreed, open a PR referencing that issue.

Typos / Small Fixes

• For clear typos or small non‑controversial fixes, you can open a PR directly without creating an issue first.

Suggested Workflow

1. Submit an issue for any non‑trivial change or addition.
2. Reach rough consensus in the discussion.
3. Open a PR that references the issue and updates the relevant stack README and/or boilerplate.