Code Hustler's Boilerplate

Boiler plate FE+BE app that tries to

• be as simple as possible
• have as little dependencies as possible
• without compromising on features and safety

Dependencies

• Deno
  • jsr:@std/assert
  • jsr:@std/testing
  • TODO: maybe do not mention std?

Features

• General
  • Format with deno fmt
  • Code checks
    • Lint with deno lint
    • Type check with deno check
    • Tests with deno test
    • Tests coverage deno coverage
    • Tests benchmarking deno bench
  • Local dependencies
• API
  • Web server with effect/platform
    • Logging with effect
    • Route shape validation with effect
  • Autogenerated Swagger
  • Typed environment variables and .env files support
  • Debugger - add --inspect-wait parameter and connect with browser dev tools
  • Api tests
  • Auth
    • Regular user
    • Admin user
• DB
  • sqlite vs postgress?
  • what about the new sql thing
    • edge db?
  • DB
  • DB migrations
• Infra
  • Jobs
    • job states
  • Cron
    • job states
  • S3/Files?
  • Emails sending?
  • logging?
  • Error logging
• Deployment
  • Auto scale group
  • Health checks
• FE
  • share with BE the api stuff https://hono.dev/docs/concepts/stacks#client
  • FE specific Lint
    • Demo's missing React rules linting
  • React (Preact?)
  • Code sharing (types and validators with API)

Notes

• Formatting
  • Works out of the box
  • Missing import/export sorting
• Lint with deno lint
  • Demo's missing floating promises rule denoland/deno_lint#303
  • No plugins (planned)
  • No React rules
• Type checking
  • Just works
• Testing
  • BDD, but when using it the VSCode testing integration stops working (denoland/vscode_deno#793)
  • Snapshot tests little awkward (you need to add --allow-read --allow-write, watch mode is not able to update the snapshots), they miss inline snapshots
  • Coverage is not able to include files without tests (denoland/deno#14281)
  • Included benchmarking tool
• Jupyter notebooks
  • [?] Brew installed Deno <> Jupyter incorrect path denoland/deno#25306
  • [?] Most chart libraries depend on browser globals, which makes it little tricky to plug in