Home

Architecture

• Monorepo: Turborepo
• App: Next.js
• View: React
• Styling: Tailwind
• ORM: Prisma

Development

Git

• main is release branch and should remain stable at all times
• Create feature branches for your in-progress features and using the format <username>/my-feature (doesn't have to be your GitHub username, just use something identifiable and be consistent about it)
• Commit messages should follow the Conventional Commits specification as much as possible
• Squash commits into a single commit before merging into main
• Delete your branch after merging into main

Editor

• VS Code is the recommended IDE due to it's superb support for TypeScript
• Install the following extensions for VS Code, or find the equivalents for your IDE:
  • Prettier - Code formatter
  • TypeScript Importer
  • Tailwind CSS IntelliSense
  • ESLint
  • Stylelint
  • Code Spell Checker
  • Optional: Tailwind Docs
• Use Workspace settings as source of truth for VS Code

Directory Structure

TBD

Front End

React

• Props should be Readonly
• Props should be sorted alphabetically
• Props should be destructured in the component function declaration

Form Library

TBD

Data Querying Library

TBD