Organize directory structure

[tkiapril]

• Standalone components and dev.ts are located at root.
• .ts files containing constant values are put to constant/.
• devTools contains standalone programs useful in development.
• messages contains codes related to messaging between components.
• prisma encapsules prisma related code (shim, wrapper, etc.).
• sample contains sample contract and related stuff.
• scripts contains standalone management scripts.
• utils contains general utility code.
• web contains web dashboard code.

closes #24

[pull-request-quantifier-deprecated]

This PR has 659 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

---

Quantification details

Label      : Extra Large
Size       : +342 -317
Percentile : 88.63%

Total files changed: 39

Change summary by file extension:
.dockerignore : +6 -5
.example : +1 -1
.gitignore : +6 -6
.md : +18 -29
.ts : +292 -266
.jsonc : +10 -3
.yml : +1 -1
.json : +1 -0
.prisma : +3 -3
Dockerfile : +4 -3

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

• Fast and predictable releases to production:
  • Optimal size changes are more likely to be reviewed faster with fewer
    iterations.
  • Similarity in low PR complexity drives similar review times.
• Review quality is likely higher as complexity is lower:
  • Bugs are more likely to be detected.
  • Code inconsistencies are more likely to be detected.
• Knowledge sharing is improved within the participants:
  • Small portions can be assimilated better.
• Better engineering practices are exercised:
  • Solving big problems by dividing them in well contained, smaller problems.
  • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

• Use the PullRequestQuantifier to quantify your PR accurately
  • Create a context profile for your repo using the context generator
  • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
  • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
  • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
• Change your engineering behaviors
  • For PRs that fall outside of the desired spectrum, review the details and check if:
    • Your PR could be split in smaller, self-contained PRs instead
    • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

• One line was added: +1 -0
• One line was deleted: +0 -1
• One line was modified: +1 -1 (git diff doesn't know about modified, it will
  interpret that line like one addition plus one deletion)
• Change percentiles: Change characteristics (addition, deletion, modification)
  of this PR in relation to all other PRs within the repository.

---

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

[eseiker]

Seems legit👍
I think it's fine to merge as is, but just for suggestion and asking for opinion,
How about flattening prisma/prisma into prisma?
And i think shim-inner naming seems a bit weird, how about renaming prisma/shim to prisma/mod and prisma/shim-inner to prisma/shim?

[tkiapril]

The reason why it has prisma/prisma is that prisma expects the schema to be at prisma/schema.prisma by default, and it expects the migrations to be inside prisma/migrations, so if we were to support db migration with multiple dbs (sqlite/postgresql) without having to switch provider every single time creating migrations, it might be better off to generate modified prisma schema files inside nested directories (prisma/prisma-sqlite and prisma/prisma-postgresql?).
I agree the name of shim-inner is weird, but the thing is that shim.ts currently also does the job of combining prisma types from index.d.ts without implementation with the Prisma namespace with implementation, so I'm a bit concerned if it's okay to rename shim.ts to mod.ts and shim-inner.ts to shim.ts (as mod.ts itself works as a second-layer shim.)

[tkiapril]

I've been thinking about good convention to rename shim-inner.ts, but I couldn't in a while, so I'll merge and keep thinking about it, and if someone or I get a good Idea make a new PR to rename it.