repository·main·Indexed 41 days ago
https://github.com/snailycad/snaily-cadv4An open-source, web-based Computer Aided Dispatch (CAD) system for FiveM communities, designed to facilitate police roleplaying and dispatching. It features a backend API, a frontend client, and optional Discord and FiveM integrations. The system includes specialized packages for shared configuration (@snailycad/config), permission management (@snailycad/permissions), data validation (@snailycad/schemas), and Prisma-generated database types (@snailycad/types).
@snailycad/config module serves as a centralized repository for shared configuration constants used across the SnailyCAD ecosystem. It provides standardized definitions for common values to ensure consistency between different packages (such as the API, client, and UI). Key constants provided by this module include SocketEvents for WebSocket communication and Cookie definitions for session management.SnailyCADv4 is split into two primary application components located in the apps/ directory:
api/: The backend service that powers the SnailyCADv4 API. It is responsible for processing all incoming requests and managing application state.client/: The frontend application. This is the user interface that end users interact with in their web browsers.@snailycad/schemas module provides the validation logic used throughout the SnailyCAD ecosystem. It is primarily used to ensure that data submitted via forms or API requests conforms to the expected structure and constraints required by the system.@snailycad/types module provides a centralized set of TypeScript definitions used to share database types across the entire SnailyCAD ecosystem. Developers should use this package to ensure type safety and consistency when interacting with database schemas or data structures shared between different parts of the CAD.@snailycad/utils package provides a collection of utility functions primarily intended for use within the client-side application.@snailycad/permissions package centralizes all SnailyCADv4 permission definitions. It provides exported functions to programmatically check user permissions, allowing for consistent access control across the application.@snailycad/types package exports TypeScript types generated by Prisma. These types represent the database schema and should be used when working with database entities to ensure type safety.@snailycad/schemas package exports validation schemas. These schemas are used by both the client and the API to validate form fields and incoming data, ensuring data integrity.@snailycad/config package contains shared configuration logic used by both the API and the client to ensure consistency across the stack.The @snailycad/ui package provides a collection of reusable UI components including form fields, inputs, overlays, and layout elements. You can import these components directly from the package entry point.
Commonly used component categories include:
SelectField, TextField, RadioGroupField, DatePickerField, AsyncListSearchField, SwitchField, and CheckboxField.Input and Textarea.Popover, Dropdown, Alert, ContextMenu, and HoverCard.Breadcrumbs, BreadcrumbItem, TabList, Accordion, and FormRow.JsonEditor, MultiForm, and Status components.