Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

Add project templates (#2138)

Ivan Starkovf659565d9646
diff --git a/apps/builder/app/dashboard/dashboard.stories.tsx b/apps/builder/app/dashboard/dashboard.stories.tsx
index 21c830c57a..eac43dc070 100644
--- a/apps/builder/app/dashboard/dashboard.stories.tsx
+++ b/apps/builder/app/dashboard/dashboard.stories.tsx
@@ -26,7 +26,9 @@ const createRouter = (element: JSX.Element) =>
]);
export const Empty: ComponentStory<typeof Dashboard> = () => {
- const router = createRouter(<Dashboard user={user} projects={[]} />);
+ const router = createRouter(
+ <Dashboard user={user} projects={[]} projectTemplates={[]} />
+ );
return <RouterProvider router={router} />;
};
@@ -43,6 +45,8 @@ export const WithProjects: ComponentStory<typeof Dashboard> = () => {
latestBuild: null,
},
];
- const router = createRouter(<Dashboard user={user} projects={projects} />);
+ const router = createRouter(
+ <Dashboard user={user} projects={projects} projectTemplates={projects} />
+ );
return <RouterProvider router={router} />;
};
diff --git a/apps/builder/app/dashboard/dashboard.tsx b/apps/builder/app/dashboard/dashboard.tsx
index 5ab464cc77..c17e87dae6 100644
--- a/apps/builder/app/dashboard/dashboard.tsx
+++ b/apps/builder/app/dashboard/dashboard.tsx
@@ -14,16 +14,21 @@ const globalStyles = globalCss({
type DashboardProps = {
user: User;
projects: Array<DashboardProject>;
+ projectTemplates: Array<DashboardProject>;
};
-export const Dashboard = ({ user, projects }: DashboardProps) => {
+export const Dashboard = ({
+ user,
+ projects,
+ projectTemplates,
+}: DashboardProps) => {
globalStyles();
return (
<>
<Header user={user} />
<main>
<Flex justify="center" as="section" css={{ minWidth: "min-content" }}>
- <Projects projects={projects} />
+ <Projects projects={projects} projectTemplates={projectTemplates} />
</Flex>
</main>
</>
diff --git a/apps/builder/app/dashboard/projects/panel.tsx b/apps/builder/app/dashboard/projects/panel.tsx
index c8acda8405..569e85bca9 100644
--- a/apps/builder/app/dashboard/projects/panel.tsx
+++ b/apps/builder/app/dashboard/projects/panel.tsx
@@ -1,4 +1,4 @@
-import { Box, css, theme } from "@webstudio-is/design-system";
+import { Flex, css, theme } from "@webstudio-is/design-system";
import type { ComponentProps } from "react";
const panelStyle = css({
@@ -12,6 +12,6 @@ const panelStyle = css({
flexGrow: 1,
});
-export const Panel = (props: ComponentProps<typeof Box>) => (
- <Box className={panelStyle()} {...props} />
+export const Panel = (props: ComponentProps<typeof Flex>) => (
+ <Flex direction="column" gap="5" className={panelStyle()} {...props} />
);
diff --git a/apps/builder/app/dashboard/projects/project-card.tsx b/apps/builder/app/dashboard/projects/project-card.tsx
index a7055e33b7..37fddff6b5 100644
--- a/apps/builder/app/dashboard/projects/project-card.tsx
+++ b/apps/builder/app/dashboard/projects/project-card.tsx
@@ -21,15 +21,15 @@ import {
DeleteProjectDialog,
useDuplicate,
ShareProjectDialog,
+ DuplicateProjectDialog,
} from "./project-dialogs";
-import { ThumbnailLink } from "./thumbnail-link";
+import { Thumbnail, ThumbnailLink } from "./thumbnail-link";
import { useNavigation } from "@remix-run/react";
import { Spinner } from "../spinner";
const containerStyle = css({
overflow: "hidden",
- width: theme.spacing[31],
- height: theme.spacing[29],
+ aspectRatio: "8 / 7",
borderWidth: 1,
borderStyle: "solid",
borderColor: theme.colors.borderMain,
@@ -133,7 +133,7 @@ const Menu = ({
};
const useProjectCard = () => {
- const thumbnailRef = useRef<HTMLAnchorElement>(null);
+ const thumbnailRef = useRef<HTMLAnchorElement & HTMLDivElement>(null);
const handleKeyDown = (event: KeyboardEvent<HTMLElement>) => {
const elements: Array<HTMLElement> = Array.from(
@@ -262,3 +262,61 @@ export const ProjectCard = ({
</Box>
);
};
+
+export const ProjectTemplateCard = ({
+ id,
+ title,
+ domain,
+ isPublished,
+}: ProjectCardProps) => {
+ const { thumbnailRef, handleKeyDown } = useProjectCard();
+ const [isDuplicateDialogOpen, setIsDuplicateDialogOpen] = useState(false);
+
+ return (
+ <Box as="article">
+ <Flex
+ direction="column"
+ align="center"
+ shrink={false}
+ className={containerStyle()}
+ tabIndex={0}
+ onKeyDown={handleKeyDown}
+ >
+ <Grid className={thumbnailStyle()}>
+ <Thumbnail
+ title={title}
+ ref={thumbnailRef}
+ onClick={() => {
+ setIsDuplicateDialogOpen(true);
+ }}
+ />
+ </Grid>
+
+ <Flex
+ justify="between"
+ shrink={false}
+ alignSelf="stretch"
+ gap="1"
+ className={footerStyle()}
+ >
+ <Flex direction="column" justify="around">
+ <Text variant="titles" truncate css={{ userSelect: "auto" }}>
+ {title}
+ </Text>
+ {isPublished ? (
+ <PublishedLink domain={domain} tabIndex={-1} />
+ ) : (
+ <Text color="subtle">Not Published</Text>
+ )}
+ </Flex>
+ </Flex>
+ </Flex>
+ <DuplicateProjectDialog
+ isOpen={isDuplicateDialogOpen}
+ onOpenChange={setIsDuplicateDialogOpen}
+ title={title}
+ projectId={id}
+ />
+ </Box>
+ );
+};
diff --git a/apps/builder/app/dashboard/projects/project-dialogs.tsx b/apps/builder/app/dashboard/projects/project-dialogs.tsx
index 3445e422f1..3787cf41e0 100644
--- a/apps/builder/app/dashboard/projects/project-dialogs.tsx
+++ b/apps/builder/app/dashboard/projects/project-dialogs.tsx
@@ -218,6 +218,79 @@ export const RenameProjectDialog = ({
);
};
+const useDuplicateProject = ({
+ projectId,
+ onOpenChange,
+}: {
+ projectId: DashboardProject["id"];
+ onOpenChange: (isOpen: boolean) => void;
+}) => {
+ const navigate = useNavigate();
+ const { send, state } = trpc.duplicate.useMutation();
+
+ const [errors, setErrors] = useState<string>();
+
+ const handleSubmit = ({ title }: { title: string }) => {
+ const parsed = Title.safeParse(title);
+ const errors =
+ "error" in parsed
+ ? parsed.error.issues.map((issue) => issue.message).join("\n")
+ : undefined;
+
+ setErrors(errors);
+
+ if (parsed.success) {
+ send({ projectId, title }, (data) => {
+ if (data?.id) {
+ navigate(builderPath({ projectId: data.id }));
+ onOpenChange(false);
+ }
+ });
+ }
+ };
+
+ return {
+ handleSubmit,
+ errors,
+ state,
+ };
+};
+
+export const DuplicateProjectDialog = ({
+ isOpen,
+ title,
+ projectId,
+ onOpenChange,
+}: {
+ isOpen: boolean;
+ title: string;
+ projectId: DashboardProject["id"];
+ onOpenChange: (isOpen: boolean) => void;
+}) => {
+ const { handleSubmit, errors, state } = useDuplicateProject({
+ projectId,
+ onOpenChange,
+ });
+ return (
+ <Dialog title="Create" isOpen={isOpen} onOpenChange={onOpenChange}>
+ <DialogContent
+ onSubmit={handleSubmit}
+ errors={errors}
+ title={title}
+ label="Project Title"
+ primaryButton={
+ <Button
+ type="submit"
+ state={state === "idle" ? undefined : "pending"}
+ >
+ Create Project
+ </Button>
+ }
+ />
+ </Dialog>
+ );
+};
+
const useDeleteProject = ({
projectId,
title,
diff --git a/apps/builder/app/dashboard/projects/projects.tsx b/apps/builder/app/dashboard/projects/projects.tsx
index 466e9f423f..78b5061620 100644
--- a/apps/builder/app/dashboard/projects/projects.tsx
+++ b/apps/builder/app/dashboard/projects/projects.tsx
@@ -1,15 +1,16 @@
-import { Flex, Text } from "@webstudio-is/design-system";
+import { Flex, Grid, Text } from "@webstudio-is/design-system";
import { EmptyState } from "./empty-state";
import { Panel } from "./panel";
import type { DashboardProject } from "@webstudio-is/dashboard";
-import { ProjectCard } from "./project-card";
+import { ProjectCard, ProjectTemplateCard } from "./project-card";
import { CreateProject } from "./project-dialogs";
type ProjectsProps = {
projects: Array<DashboardProject>;
+ projectTemplates: Array<DashboardProject>;
};
-export const Projects = ({ projects }: ProjectsProps) => {
+export const Projects = ({ projects, projectTemplates }: ProjectsProps) => {
return (
<Panel>
<Flex direction="column" gap="3">
@@ -20,12 +21,37 @@ export const Projects = ({ projects }: ProjectsProps) => {
<CreateProject />
</Flex>
{projects.length === 0 && <EmptyState />}
- <Flex gap="6" wrap="wrap">
+ <Grid
+ gap="6"
+ css={{
+ gridTemplateColumns: "repeat(auto-fill, minmax(256px, 1fr))",
+ }}
+ >
{projects.map((project) => {
return <ProjectCard {...project} key={project.id} />;
})}
- </Flex>
+ </Grid>
</Flex>
+
+ {projectTemplates.length > 0 && (
+ <Flex direction="column" gap="3">
+ <Flex justify="between">
+ <Text variant="brandSectionTitle" as="h2">
+ Templates
+ </Text>
+ </Flex>
+ <Grid
+ gap="6"
+ css={{
+ gridTemplateColumns: "repeat(auto-fill, minmax(256px, 1fr))",
+ }}
+ >
+ {projectTemplates.map((project) => {
+ return <ProjectTemplateCard {...project} key={project.id} />;
+ })}
+ </Grid>
+ </Flex>
+ )}
</Panel>
);
};
diff --git a/apps/builder/app/dashboard/projects/thumbnail-link.tsx b/apps/builder/app/dashboard/projects/thumbnail-link.tsx
index 1e17d1521b..21f334e4e0 100644
--- a/apps/builder/app/dashboard/projects/thumbnail-link.tsx
+++ b/apps/builder/app/dashboard/projects/thumbnail-link.tsx
@@ -37,4 +37,16 @@ export const ThumbnailLink = forwardRef<
);
});
+export const Thumbnail = forwardRef<
+ HTMLDivElement,
+ { title: string; onClick: React.MouseEventHandler<HTMLDivElement> }
+>(({ title, onClick }, ref) => {
+ return (
+ <div ref={ref} onClick={onClick} className={thumbnailStyle()} tabIndex={-1}>
+ {getThumbnailAbbreviation(title)}
+ </div>
+ );
+});
+
+Thumbnail.displayName = "Thumbnail";
ThumbnailLink.displayName = "ThumbnailLink";
diff --git a/apps/builder/app/env/env.server.ts b/apps/builder/app/env/env.server.ts
index d536495cce..2f7b9e19e1 100644
--- a/apps/builder/app/env/env.server.ts
+++ b/apps/builder/app/env/env.server.ts
@@ -77,6 +77,14 @@ const env = {
*/
ENTRI_APPLICATION_ID: process.env.ENTRI_APPLICATION_ID ?? "webstudio",
ENTRI_SECRET: process.env.ENTRI_SECRET,
+
+ /**
+ * Projects as templates in dashboard
+ */
+ PROJECT_TEMPLATES:
+ process.env.PROJECT_TEMPLATES?.split(",").map((projectId) =>
+ projectId.trim()
+ ) ?? [],
};
export type ServerEnv = typeof env;
diff --git a/apps/builder/app/routes/dashboard._index.tsx b/apps/builder/app/routes/dashboard._index.tsx
index c3cd31f5c8..c5e01d84e5 100644
--- a/apps/builder/app/routes/dashboard._index.tsx
+++ b/apps/builder/app/routes/dashboard._index.tsx
@@ -9,6 +9,7 @@ import { loginPath } from "~/shared/router-utils";
import { sentryException } from "~/shared/sentry";
import { ErrorMessage } from "~/shared/error";
import { createContext } from "~/shared/context.server";
+import env from "~/env/env.server";
export const loader = async ({
request,
@@ -31,7 +32,15 @@ export const loader = async ({
.createCaller(context)
.findMany({ userId: user.id });
- return { user, projects };
+ const projectIds = env.PROJECT_TEMPLATES;
+
+ const projectTemplates = await dashboardProjectRouter
+ .createCaller(context)
+ .findManyByIds({
+ projectIds,
+ });
+
+ return { user, projects, projectTemplates };
};
export const ErrorBoundary = () => {
diff --git a/apps/builder/app/shared/context.server.ts b/apps/builder/app/shared/context.server.ts
index 9c4d15e548..fe4ea64c17 100644
--- a/apps/builder/app/shared/context.server.ts
+++ b/apps/builder/app/shared/context.server.ts
@@ -21,6 +21,7 @@ const createAuthorizationContext = async (
userId: user?.id,
authToken,
isServiceCall,
+ projectTemplates: env.PROJECT_TEMPLATES,
authorizeTrpc: trpcClient.authorize,
};
diff --git a/packages/dashboard/src/db/projects.ts b/packages/dashboard/src/db/projects.ts
index 5a38795fe0..d23a735d50 100644
--- a/packages/dashboard/src/db/projects.ts
+++ b/packages/dashboard/src/db/projects.ts
@@ -20,3 +20,31 @@ export const findMany = async (userId: string, context: AppContext) => {
return DashboardProjects.parse(data);
};
+
+export const findManyByIds = async (
+ projectIds: string[],
+ context: AppContext
+) => {
+ if (projectIds.length === 0) {
+ return DashboardProjects.parse([]);
+ }
+
+ const data = await prisma.dashboardProject.findMany({
+ where: {
+ id: {
+ in: projectIds,
+ },
+ isDeleted: false,
+ },
+ orderBy: [
+ {
+ createdAt: "desc",
+ },
+ {
+ id: "desc",
+ },
+ ],
+ });
+
+ return DashboardProjects.parse(data);
+};
diff --git a/packages/dashboard/src/trpc/project-router.ts b/packages/dashboard/src/trpc/project-router.ts
index a26b702cfc..8d07d4421e 100644
--- a/packages/dashboard/src/trpc/project-router.ts
+++ b/packages/dashboard/src/trpc/project-router.ts
@@ -17,6 +17,16 @@ const projectRouter = router({
.query(async ({ input, ctx }) => {
return await db.findMany(input.userId, ctx);
}),
+
+ findManyByIds: procedure
+ .input(
+ z.object({
+ projectIds: z.array(z.string()),
+ })
+ )
+ .query(async ({ input, ctx }) => {
+ return await db.findManyByIds(input.projectIds, ctx);
+ }),
});
export const dashboardProjectRouter = mergeRouters(
diff --git a/packages/project/src/db/project.ts b/packages/project/src/db/project.ts
index 8d4e5172ba..7105538857 100644
--- a/packages/project/src/db/project.ts
+++ b/packages/project/src/db/project.ts
@@ -183,7 +183,16 @@ const clone = async (
return Project.parse(clonedProject);
};
-export const duplicate = async (projectId: string, context: AppContext) => {
+export const duplicate = async (
+ {
+ projectId,
+ title,
+ }: {
+ projectId: string;
+ title?: string | undefined;
+ },
+ context: AppContext
+) => {
const project = await loadById(projectId, context);
if (project === null) {
throw new Error(`Not found project "${projectId}"`);
@@ -191,7 +200,7 @@ export const duplicate = async (projectId: string, context: AppContext) => {
return await clone(
{
project,
- title: `${project.title} (copy)`,
+ title: title ?? `${project.title} (copy)`,
},
context
);
diff --git a/packages/project/src/trpc/project-router.ts b/packages/project/src/trpc/project-router.ts
index f49f8ee9ba..2eee625179 100644
--- a/packages/project/src/trpc/project-router.ts
+++ b/packages/project/src/trpc/project-router.ts
@@ -22,9 +22,15 @@ export const projectRouter = router({
return await db.project.markAsDeleted(input.projectId, ctx);
}),
duplicate: procedure
- .input(z.object({ projectId: z.string() }))
+ .input(z.object({ projectId: z.string(), title: z.optional(z.string()) }))
.mutation(async ({ input, ctx }) => {
- return await db.project.duplicate(input.projectId, ctx);
+ return await db.project.duplicate(
+ {
+ projectId: input.projectId,
+ title: input.title,
+ },
+ ctx
+ );
}),
create: procedure
.input(z.object({ title: Title }))
diff --git a/packages/trpc-interface/src/authorize/project.server.ts b/packages/trpc-interface/src/authorize/project.server.ts
index 4dde10c037..c03cf63c50 100644
--- a/packages/trpc-interface/src/authorize/project.server.ts
+++ b/packages/trpc-interface/src/authorize/project.server.ts
@@ -62,6 +62,13 @@ export const hasProjectPermit = async (
return true;
}
+ if (
+ props.permit === "view" &&
+ context.authorization.projectTemplates.includes(props.projectId)
+ ) {
+ return true;
+ }
+
// Check if the user is allowed to access the project
if (authorization.userId !== undefined) {
checks.push(
diff --git a/packages/trpc-interface/src/context/context.server.ts b/packages/trpc-interface/src/context/context.server.ts
index 02cc5d13fd..7acc151ede 100644
--- a/packages/trpc-interface/src/context/context.server.ts
+++ b/packages/trpc-interface/src/context/context.server.ts
@@ -14,6 +14,11 @@ type AuthorizationContext = {
*/
authToken: string | undefined;
+ /**
+ * project list serves as a template and is accessible to everyone.
+ */
+ projectTemplates: string[];
+
/**
* Allow service 2 service communications to skip authorization for view calls
*/