Skip to main content

Table of Contents

A quick overview of this documentation.


SectionDescription
SchemasHow to define model schemas to power your app
Schemas & CollectionsThe basics of creating a new collection
Schema PropertiesAvailable schema properties
Field ResolversHow to make schema fields "resolve" into complex objects
RelationsHow to define relations between documents
GraphQL APIHow to define model schemas to power your app
GraphQL SchemaHow to access your generated GraphQL schema
QueriesQuerying for data (read)
FilteringHow to narrow down the data you query for
MutationsMutating data (create, update, delete)
FragmentsHow to control which fields you receive on the client
Querying on the ServerUsing GraphQL queries from the server
Connecting RemotelyUsing your GraphQL API from another server
FeaturesCore Vulcan features
RoutingHow to declare routes
SettingsStoring and retrieving app-level settings
Groups & PermissionsControlling permissions with groups and functions
CallbacksHow to add callback functions after key operations (create, update, etc.)
UsersManaging users
InternationalizationMaking your UI and database contents available in multiple languages
Head TagsControl your app's meta tags
Errors & MessagesShowing users error messages
ComponentsVulcan's built-in components
ComponentsRegistering, using, and replacing components
UI ComponentsUsing UI themes (Bootstrap, Material, etc.) with Vulcan
DatatableThe Datatable component
Form ComponentsComponents used to build forms
Other ComponentsOther built-in components
FormsVulcan's form generation and form handling
FormsUsing “new” and “edit” forms
Custom FormsCustomizing your forms
ServerServer-level concerns
PerformanceEnsuring your Vulcan app runs smoothly
Database LayerAccessing the database
TestingTesting your app
Unit TestingUnit Testing with Mocha
StorybookComponent testing with Storybook