- Refer to the Contributing Guideline for more information.
- Node (18 or higher)
- Acces to the Sanity project (provided by an admin)
- A
.env.localfile with necessary environment variables - obtain from an admin
git clone https://github.com/fnhan/curate-health.git
cd curate-health
cp .env.example .env.local
npm install
npm run dev- This repo uses shadcn for UI components. When installing a new component they will be added to the
components/uifolder. - Components that belong to specific pages should correspond to the page they belong to. For example, the
components/layout/home-pagefolder contains all the components for the home page. - The
pagesfolder contains folders which belong to a page. For example, thepages/productsfolder contains all the files for the products page, whereindex.tsxinside the folder serves as the page.
To contribute to the content management aspect of Curate Health, you will need to be added to the existing Sanity project by an admin. Once added, you'll have access to Sanity Studio where you can manage content schemas, documents, and more.
Our Sanity setup includes:
- Sanity Studio: Located in the
sanityfolder at the root of the project - Schemas: Defined within the
sanity/schemasdirectory, these schemas dictate the structure of the content types within this project. - Configuration: Essential project settings are located in
sanity/env.tsandsanity/schema.ts
- Run
npm run dev - Visit
localhost:3000/studio
This setup simulates the behavior of the deployed site locally.
For detailed instructions on using Sanity, refer to this Sanity Guide.