Skip to content

Commit

Permalink
update readme and add todo for future client support
Browse files Browse the repository at this point in the history
  • Loading branch information
christinaroise committed Aug 26, 2024
1 parent f4f13cc commit 3898630
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sankitty
# Variant .no/.se

Sankitty is a Next.js and Sanity-powered project designed to accelerate the development process from prototype to production. With minimal configuration and boilerplate, Sankitty allows developers to quickly get started on building user interfaces while maintaining full control over both UI and content.
Variant’s webpages are based off of Sankitty a Next.js and Sanity-powered project designed to accelerate the development process from prototype to production. With minimal configuration and boilerplate, Sankitty allows developers to quickly get started on building user interfaces while maintaining full control over both UI and content. This project has been customized to meet the specific needs of Variant’s websites for .no and .se domains.

## Key Features

Expand All @@ -11,6 +11,20 @@ Sankitty is a Next.js and Sanity-powered project designed to accelerate the deve
- **Universal Content Control:** Manage everything from a single location in Sanity—menus, SEO settings, logos, pages, blogs, and posts—offering a unified content management experience.
- **Custom Theming and Typography:** Global styles such as colors are managed in global.css, while typography is primarily controlled within Text.tsx, ensuring a consistent design language throughout the application.

## Shared Studio

In addition to the primary Sanity Studio (accessible at http://localhost:3000/studio), this project includes a secondary studio called Shared Studio. This studio is designed to manage shared content between the different domains .no and .se, such as blog posts and customer cases.

### Features of Shared Studio

• Blog Posts: In the Shared Studio, you can create and manage Blog Posts. This content type allows for creating articles that can be displayed across different parts of the application.
• Customer Cases: Customer Cases is another content type available in the Shared Studio, enabling you to showcase client stories or testimonials.

Accessing Shared Studio

• Studio URL: The Shared Studio is accessible at http://localhost:3000/shared.
• Frontend Access: Content from the Shared Studio can be accessed on the frontend through API calls using sharedClient or loadSharedQuery.

## Getting Started

To get started with Sankitty, follow these steps:
Expand Down Expand Up @@ -57,6 +71,7 @@ To get started with Sankitty, follow these steps:
- `npm run dev`: Start the Next.js development server.
- `npm run build`: Build the Next.js application for production.
- `npm run start`: Start the Next.js application in production mode.
- `npx prettier . --write`: Format the codebase using Prettier to ensure consistent code style across the project.
- `npm run lint`: Lint the project using ESLint.

## Project Structure
Expand Down
3 changes: 2 additions & 1 deletion src/utils/hooks/useConvertImage.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { useNextSanityImage } from "next-sanity-image";
// TODO: add support for sharedClient
import { client } from "studio/lib/client";
import { IImage } from "studio/lib/payloads/media";
import Image from "next/image";
Expand Down Expand Up @@ -45,7 +46,7 @@ const SanityImage = ({ image }: { image: IImage }) => {

// Custom hook for converting an image from Sanity to Next.js image component
export function useConvertSanityImageToNextImage(
image: IImage | undefined,
image: IImage | undefined
): JSX.Element | null {
// Return mockData.image for stories in Storybook
if (image?.src) {
Expand Down

0 comments on commit 3898630

Please sign in to comment.