A Vite-powered React app for the Refurrm Creator Studio experience. This repository contains the client application and UI flows for creator onboarding, storefront, dashboard, and admin tools.
- Install dependencies:
npm install- Start the dev server:
npm run dev- Open the app:
- Default Vite dev server: http://localhost:5173
- The Vite settings say: “listen on all network addresses” and “use port 8080.” So if you use those settings, the app runs on port 8080 instead of 5173.
npm run devStart Vite dev servernpm run buildBuild for productionnpm run build:devBuild in development modenpm run previewPreview the production build locallynpm run lintRun ESLintnpm run testRun Vitest
- Vite 7
- React 18
- TypeScript
- Tailwind CSS
- React Router
- Supabase client
- shadcn/ui (Radix UI primitives)
src/Application sourcesrc/pages/Route-level pagessrc/components/Feature componentssrc/components/ui/UI primitivessrc/contexts/App/auth context providerssrc/lib/Helpers and API clientspublic/Static assets
Create a .env file in the project root with the following:
VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_keyIf you add additional integrations, document them here.
Routes are defined in src/App.tsx. Pages should live in src/pages and be lazy-loaded into the router.
- Lint before pushing changes:
npm run lint- Run unit tests (if present):
npm run testProduction builds are written to dist/.
vite.config.tsusesmodefor sourcemaps and terser options.- If you see errors related to duplicate imports or invalid JSON in
package.json, verify the file is valid JSON and there are no duplicate dependency entries.
This repository uses multiple branches for feature development. To keep the repository clean:
- Delete branches after merging PRs using GitHub's "Delete branch" button
- Run regular cleanups using the provided script:
# Preview branches that can be deleted ./scripts/cleanup-branches.sh --dry-run # Delete merged branches ./scripts/cleanup-branches.sh
- Review the automated cleanup issues created weekly by the Branch Cleanup workflow
For more details, see BRANCH_MANAGEMENT.md
- Keep components small and composable.
- Prefer
@/alias imports fromsrc. - Avoid introducing secrets into the repo.