NOTES.md

Dev Notes

Project Structure

• entities — business entities. (e.g., User, Client, Website, WebsitePage)
  • user - user specific functionality
  • client - user specific functionality
  • website - user specific functionality
• features — user interactions, actions that bring business value to the user. (e.g. UsersSearch, DataTable)
• providers — global providers, such as QueryClientProvider, AuthProvider, ThemeProvider.
• routes — compositional layer to construct full pages from entities, features and widgets.
• shared — reusable functionality, detached from the specifics of the project/business.
  • api - api calls to the backend
  • sass - global styles
  • utils - utility functions
  • server - server side code
• widgets — compositional layer to combine entities and features into meaningful blocks. (e.g. UserProfile, CoreWebVitalsGraph)

Git Branch Heirarchy

• main - main branch used for production
• dev - branch for integrating base code for testing and staging
• base - base branch for integrating feature branches
  • feat- - feature branches for developing new features

---

Dependencies

Routing

• Solid Router

Data Management

• Tanstack Query (Solid)
• Tanstack Form (Solid)
• TanStack Table (Solid)

Auth

• Auth0 JS

Theme & Styles

• Kobalte
• TailwindCSS

---

Patterns

Folder Structure

• Feature Sliced Design (FSD)
  • FSD Realworld React Example

Component Patterns

• SolidJS Patterns

Resources

• SolidJS
• SolidStart
• SolidStart Repo

Solid Start Examples

• Route Fetching