Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
95 lines (62 loc) · 2.34 KB

DEVELOPMENT.md

File metadata and controls

95 lines (62 loc) · 2.34 KB

Development

This guide provides instructions on how to set up and run the project locally.

Prerequisites

Ensure you have the following installed:

Setup

1. Clone the repository

git clone https://github.com/PrashantIndurkar/devfolio
cd devfolio

2. Install dependencies

pnpm i

3. Configure Environment Variables

Create a .env.local file based on .env.example:

cp .env.example .env.local

Then, update the necessary environment variables inside .env.local.

4. Run the development server

pnpm dev

The application should now be available at http://localhost:1408

Building for Production

pnpm build

After building, start the application with:

NODE_ENV=production pnpm start

Registry

This project utilizes shadcn Registry, which allows you to manage and distribute custom components, hooks, pages, and other files across multiple React projects. By hosting a registry, you can reuse UI components easily without manually copying code between projects.

Using Registry in other React projects

If you're working on a different React project and want to reuse the custom components from this repository, you can add them using the shadcn CLI with the following commands:

npx shadcn add @ncdai/utils
npx shadcn add @ncdai/use-controllable-state
npx shadcn add @ncdai/use-sound
npx shadcn add @ncdai/theme-switcher
npx shadcn add @ncdai/flip-sentences
npx shadcn add @ncdai/apple-hello-effect
npx shadcn add @ncdai/wheel-picker
npx shadcn add @ncdai/work-experience
npx shadcn add @ncdai/shimmering-text
npx shadcn add @ncdai/slide-to-unlock

Note: These components are compatible with Tailwind CSS v4 and React 19.

Registry configuration

Documentation: shadcn Registry Docs

Source files:

  • ./src/registry

Before using the registry, run the following command to build and generate the registry JSON files:

pnpm registry:build

When running the npx shadcn add <registry-url> command, the selected component will be automatically downloaded and integrated into your project.