https://github.com/coderdeltalan/star-template
https://github.com/coderdeltalan/star-template
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/coderdeltalan/star-template
- Owner: CoderDeltaLAN
- License: other
- Created: 2025-09-10T09:08:12.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-10-06T14:52:12.000Z (3 months ago)
- Last Synced: 2025-10-07T00:45:40.998Z (3 months ago)
- Language: Shell
- Size: 281 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
# ⭐ Star Template — Always-Green Starter for Node + Python
A lean, production-grade template for **TypeScript libraries** and **Python packages** with a **strict green workflow**.
It mirrors CI locally, enforces style/tests/typing, ships with **GitHub Actions** (Linux matrix) and **CodeQL**, and keeps histories clean and linear.
Use it to bootstrap small libs or new repos that must **stay green**, integrate safely, and scale with confidence.
[](https://github.com/CoderDeltaLAN/star-template/actions/workflows/build.yml)
[](https://github.com/CoderDeltaLAN/star-template/actions/workflows/codeql.yml)
[](LICENSE)
[](https://www.paypal.com/donate/?hosted_button_id=YVENCBNCZWVPW)
---
## Repo layout
```text
.
├── lib/ # TS build output
├── test/ # TS tests (Jest)
├── src/star_template/ # Python package
├── tests/ # Python tests (pytest)
└── .github/workflows/ # build.yml, codeql.yml
```
---
## 🚀 Quick Start
### Node / TypeScript
```bash
npm ci
npx prettier -c .
npx eslint . --max-warnings=0
[ -f tsconfig.json ] && npx tsc -p tsconfig.json --noEmit || true
npm test --silent
```
Pack + smoke locally:
```bash
npm pack
mkdir -p /tmp/star-template-npm-smoke && cd /tmp/star-template-npm-smoke
npm init -y >/dev/null
npm install "/absolute/path/to/star-template-ts-.tgz" --silent
node -e "require('star-template-ts'); console.log('node import OK')"
```
### Python
```bash
poetry install --no-interaction
poetry run ruff check .
poetry run black --check .
PYTHONPATH=src poetry run pytest -q
poetry run mypy src
poetry build
python - <<'PY'
import importlib; m = importlib.import_module("star_template")
print("python import OK:", getattr(m, "__version__", "unknown"))
PY
```
---
## 🧪 Local Developer Workflow (mirrors CI)
```bash
# Node
npx prettier -c .
npx eslint . --max-warnings=0
[ -f tsconfig.json ] && npx tsc --noEmit || true
npm test --silent
# Python
poetry run ruff check .
poetry run black --check .
PYTHONPATH=src poetry run pytest -q
poetry run mypy src
```
---
## 🔧 CI (GitHub Actions)
- Linux matrix for Node and Python (3.11, 3.12).
- Jobs match local gates to avoid “works-on-my-machine”.
- **Logs per job** are uploaded as artifacts for troubleshooting.
- **CodeQL** enabled for static analysis.
Example Python job steps:
```yaml
- run: python -m pip install -U pip
- run: pip install ruff black pytest mypy
- run: ruff check .
- run: black --check .
- run: pytest -q
- run: mypy src
```
---
## 🗺️ When to Use This Template
- You need a **minimal yet strict** starter for Node + Python libs.
- **Always-green** policy: PRs blocked unless checks pass.
- You value **linear history** (squash merge) and reproducible local gates.
---
## 🧩 Customization
- Use only one stack? Remove the other stack’s files and its CI job.
- Add Windows/macOS runners by extending `build.yml`.
- Lower strictness (e.g., Python coverage) by adjusting `pytest.ini`.
---
## 🛡️ Security
- Private disclosures via GitHub Security advisories.
- **CodeQL** runs on PRs and pushes to `main`.
---
## 🙌 Contributing
- **Small, atomic PRs** with Conventional Commits.
- Keep **local gates** green before pushing.
- Enable **auto-merge** once checks pass.
---
## 📈 SEO Keywords
always green ci template, always-green workflow, typescript library starter, node eslint prettier jest template,
python package template poetry, ruff black pytest mypy starter, github actions matrix ci, codeql security scan template,
branch protection required checks, dual stack repo template, clean history conventional commits, npm pack smoke test,
poetry build smoke test, linux matrix ci, job log artifacts, reproducible dev workflow
---
## 👤 Author
**CoderDeltaLAN (Yosvel)**
Email: `coderdeltalan.cargo784@8alias.com`
GitHub: https://github.com/CoderDeltaLAN
---
## 💚 Donations & Sponsorship
Open-source takes time. If this template saves you hours, consider supporting continued maintenance and polish. Thank you!
[](https://www.paypal.com/donate/?hosted_button_id=YVENCBNCZWVPW)
---
## 📄 License
Released under the **Apache License 2.0**. See [LICENSE](LICENSE).