{"id":31070872,"url":"https://github.com/mstsurnalyakter/foundx-client","last_synced_at":"2026-05-08T09:32:07.474Z","repository":{"id":313304558,"uuid":"1050882636","full_name":"mstsurnalyakter/FoundX-Client","owner":"mstsurnalyakter","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-13T04:48:34.000Z","size":153,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-13T06:31:43.167Z","etag":null,"topics":["heroui","jwt-token","nextjs","react-hook-form","sonner","tanstack-react-query","typescript","zod"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mstsurnalyakter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-05T05:10:10.000Z","updated_at":"2025-09-13T04:48:38.000Z","dependencies_parsed_at":"2025-09-05T07:24:28.943Z","dependency_job_id":"30ea66ef-edbe-4f04-8ea7-53e2376d33ea","html_url":"https://github.com/mstsurnalyakter/FoundX-Client","commit_stats":null,"previous_names":["mstsurnalyakter/foundx-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mstsurnalyakter/FoundX-Client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstsurnalyakter%2FFoundX-Client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstsurnalyakter%2FFoundX-Client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstsurnalyakter%2FFoundX-Client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstsurnalyakter%2FFoundX-Client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mstsurnalyakter","download_url":"https://codeload.github.com/mstsurnalyakter/FoundX-Client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mstsurnalyakter%2FFoundX-Client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275333311,"owners_count":25446100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["heroui","jwt-token","nextjs","react-hook-form","sonner","tanstack-react-query","typescript","zod"],"created_at":"2025-09-15T23:03:23.343Z","updated_at":"2026-05-08T09:32:07.461Z","avatar_url":"https://github.com/mstsurnalyakter.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FoundX — Lost \u0026 Found Web App\n\nFoundX is a full‑stack Lost \u0026 Found application. Frontend is a Next.js + TypeScript app (client folder) and the backend is an Express + TypeScript API (server folder). This README explains how to run, build, and deploy both parts, plus required environment variables (including Meilisearch).\n\n## Contents\n- Overview\n- Features\n- Tech stack\n- Repo layout\n- Quick start (local)\n- Environment variables (.env examples)\n- Meilisearch notes\n- Postman collection\n- Deployment (Vercel for frontend + recommended for backend)\n- Troubleshooting \u0026 tips\n- License\n\n## Overview\nFoundX lets users post found items with images, answer verification questions, submit claim requests, and search items. The frontend is in `FoundX-Client`, backend in `FoundX-Server`.\n\n## Features\n- User auth (JWT + refresh)\n- Item CRUD with image upload (Cloudinary)\n- Claim request workflow\n- Full‑text search (Meilisearch)\n- Social sharing + native share\n- Responsive UI (Tailwind CSS + HeroUI)\n- Deployed frontend on Vercel (recommended)\n\n## Tech stack\n- Frontend: Next.js (App Router), React, TypeScript, Tailwind CSS, HeroUI, React Query\n- Backend: Node.js, Express, TypeScript, MongoDB, Meilisearch, Cloudinary\n- Dev/deploy: Vercel (frontend), Render/Heroku/VM (backend), Postman for API testing\n\n## Repo layout\n- FoundX-Client/ — Next.js frontend\n- FoundX-Server/ — Express API + TypeScript\n- README.md — this file\n- FoundX-Server/FoundX.postman_collection.json — Postman collection\n\n## Quick start (local)\n\nPrereqs:\n- Node 18+\n- yarn or npm\n- MongoDB instance (local or Atlas)\n- Meilisearch instance (optional for search)\n- Cloudinary account (optional for image uploads)\n\nServer\n```bash\ncd FoundX-Server\nyarn install\n# create .env (see sample below)\nyarn dev        # development with ts-node-dev\nyarn build      # compile to dist\nyarn start      # run compiled server\n```\n\nClient\n```bash\ncd FoundX-Client\nyarn install\n# create .env.local (see sample below)\nyarn dev        # run Next.js dev server\nyarn build      # production build\nyarn start      # run build locally\n```\n\n## Environment variables\n\nFoundX-Server (.env)\n```text\nPORT=5000\nMONGO_URI=\nJWT_SECRET=your_jwt_secret\nREFRESH_TOKEN_SECRET=your_refresh_secret\nCLOUDINARY_CLOUD_NAME=...\nCLOUDINARY_API_KEY=...\nCLOUDINARY_API_SECRET=...\nMEILISEARCH_HOST=https://xxx.meilisearch.io\nMEILISEARCH_API_KEY=your_meili_key\n```\n\nFoundX-Client (.env.local)\n```text\nNEXT_PUBLIC_BACKEND_URL=https://api.your-backend.com/api/v1\nNEXT_PUBLIC_CLOUDINARY_UPLOAD_PRESET=...\nNEXT_PUBLIC_MEILISEARCH_HOST=https://xxx.meilisearch.io\n# any other NEXT_PUBLIC_* variables required by client\n```\n\nImportant: The client needs NEXT_PUBLIC_BACKEND_URL (or envConfig.backendURL) during build to avoid prerender errors like `Failed to parse URL from undefined/...`.\n\n## Meilisearch\n- Configure MEILISEARCH_HOST and MEILISEARCH_API_KEY on the server.\n- Create an index named `items` and tune searchable attributes (title, description, location).\n- Index documents after item create/update/delete (server-side hook).\n\nBasic server client example:\n```ts\nimport { MeiliSearch } from \"meilisearch\";\nconst meili = new MeiliSearch({ host: process.env.MEILISEARCH_HOST, apiKey: process.env.MEILISEARCH_API_KEY });\nawait meili.index('items').addDocuments([...]);\n```\n\n## Postman\nImport `FoundX-Server/FoundX.postman_collection.json`. Update the `BASE_API` variable to your server URL (e.g. `http://localhost:5000/api/v1`).\n\n## Deployment\n\nFrontend (Vercel)\n- Connect the `FoundX-Client` repo to Vercel, set Root Directory to `FoundX-Client` if needed.\n- Add env vars in Project → Settings (NEXT_PUBLIC_BACKEND_URL, etc.).\n- Build Command: `yarn build` (Next auto-detected).\n- Deploy.\n\nBackend\n- Deploy to Render / Heroku / your preferred host.\n- Ensure environment variables are configured on the host (MONGO_URI, Cloudinary, Meilisearch keys, JWT secrets).\n- If you deploy serverless (Vercel functions), adapt routes accordingly.\n\n## Troubleshooting \u0026 tips\n- Tailwind: ensure `postcss.config.js` uses `@tailwindcss/postcss` (install `@tailwindcss/postcss` + `autoprefixer`) for newer Tailwind/PostCSS setups.\n- Prerender error: set NEXT_PUBLIC_BACKEND_URL to avoid `Failed to parse URL from undefined/...`.\n- Edge runtime warnings: libraries like axios may use Node APIs; avoid importing them in Edge-compiled serverless functions.\n- If global CSS not applied, ensure `src/app/layout.tsx` imports `./globals.css` and layout is a server component.\n\n## Contributing\n- Fork → new branch → PR.\n- Run linter/formatter and tests (if added).\n- Keep envs out of the repo; include `.env.example` only.\n\n## License\nMIT\n\n## Contact\nRepository links:\n- Live Link: https://foundx-item.vercel.app\n- Backend GitHub : https://github.com/mstsurnalyakter/FondX-server\n- Frontend GitHub: https://github.com/mstsurnalyakter/FoundX-Client","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmstsurnalyakter%2Ffoundx-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmstsurnalyakter%2Ffoundx-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmstsurnalyakter%2Ffoundx-client/lists"}