mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-26 20:00:08 +00:00
ed553f1f19
Updates the backend listen port, Vite dev proxy target, Docker EXPOSE, compose port mapping, .env.example default, GitHub Actions smoke-test default, healthcheck URLs, and every doc/example reference. Test fixtures that include example URLs were updated for consistency, though their assertions are port-agnostic. The rate-limit value of 3000 in middleware/rateLimiters.ts and the 3000 entry in WEB_UI_PORTS (which detects user containers like Grafana) are intentionally untouched.
1.8 KiB
1.8 KiB
Contributing to Sencho
Thank you for your interest in contributing to Sencho!
Getting Started
- Fork the repository
- Clone your fork:
git clone https://github.com/YOUR_USERNAME/Sencho.git - Create a branch:
git checkout -b feature/your-feature - Install dependencies:
cd backend && npm install cd ../frontend && npm install - Start the dev servers:
cd backend && npm run dev # Express + nodemon on :1852 cd frontend && npm run dev # Vite on :5173
Development
- Backend: Node.js + Express + TypeScript in
backend/ - Frontend: React 19 + Vite + TypeScript in
frontend/ - Tests:
cd backend && npm test(Vitest) andnpm run test:e2e(Playwright) - Lint:
npm run lintin bothbackend/andfrontend/
Pull Request Process
- All PRs target
main - Ensure CI passes before requesting review
- Use Conventional Commits for commit messages
- Update documentation if your change affects user-facing behavior
- Add tests for new functionality
- Keep PRs focused - one feature or fix per PR
- Do not edit
CHANGELOG.mddirectly. It is generated from your conventional-commit subjects by release-please. If a user-facing change needs more context than the commit subject captures, enrich the auto-opened Release PR description before it is merged.
Reporting Bugs
Use the bug report template. Include: deployment method, Sencho version, browser (for UI issues), steps to reproduce, and expected vs actual behavior.
Code Style
- TypeScript with
strict: true- noanycasts or@ts-ignore - ESLint 9 flat config for both backend and frontend
- Tailwind CSS + shadcn/ui for frontend styling
- Follow existing patterns in the codebase