laterbox logo
laterbox/docs
Docs/Developer/Contributing Guide
3 min readv1.0.68

Contributing Guide

How to set up your local development environment, run test suites, and submit pull requests.

Development Setup#

Follow these steps to set up your local development environment:

1. Fork and Clone Repository

bash
git clone https://github.com/Chaste-Djaziri/laterbox.git
cd laterbox

2. Install Flutter & Web Dependencies

bash
# Install Flutter dependencies
flutter pub get

# Install Next.js web dependencies
cd laterbox-web && npm install

3. Run Static Analysis & Tests

bash
# Run Flutter analysis and unit tests
flutter analyze
flutter test

# Verify Next.js production build
cd laterbox-web && npm run build

Testing Guidelines#

  • Flutter Unit & Widget Tests: Located in test/. Run with flutter test.
  • Edge Function Tests: Located in supabase/functions/enrich-url/classification.test.ts. Run with deno test.
  • Next.js Production Build: Run npm run build inside laterbox-web/.

Submitting Pull Requests#

  • Use Conventional Commits (feat:, fix:, docs:, chore:).
  • Commit each modified file independently whenever making architectural changes.
  • Ensure all tests and static analysis checks pass before opening your PR.
Questions or suggestions for this documentation?
Edit on GitHubJoin Community