An open API service indexing awesome lists of open source software.

https://github.com/shahid-cp/lost-find-project-client

WhereIsIt is a user-friendly platform to report and find lost or found items easily.
https://github.com/shahid-cp/lost-find-project-client

axios firebase framer-motion react react-icons react-router tailwind-css vite

Last synced: 3 months ago
JSON representation

WhereIsIt is a user-friendly platform to report and find lost or found items easily.

Awesome Lists containing this project

README

          

# React + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration

If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.

# 📅 Project Name: WhereIsIt

## 🌟 Purpose
āĻāχ āĻĒā§āϰāĻœā§‡āĻ•ā§āϟāϟāĻŋāϰ āĻŽā§‚āϞ āϞāĻ•ā§āĻˇā§āϝ āĻšāϞ – āĻšāĻžāϰāĻŋā§Ÿā§‡ āϝāĻžāĻ“ā§ŸāĻž āĻ“ āĻĒāĻžāĻ“ā§ŸāĻž āϜāĻŋāύāĻŋāϏāĻĒāĻ¤ā§āϰ⧇āϰ āϤāĻĨā§āϝ āĻāĻ•āϟāĻŋ āχāωāϜāĻžāϰ-āĻĢā§āϰ⧇āĻ¨ā§āĻĄāϞāĻŋ āĻĒā§āĻ˛ā§āϝāĻžāϟāĻĢāĻ°ā§āĻŽā§‡ āϏāĻ‚āϰāĻ•ā§āώāĻŖ āĻ“ āĻ–ā§‹āρāϜāĻžāϰ āϏ⧁āϝ⧋āĻ— āĻ•āϰ⧇ āĻĻ⧇āĻ“ā§ŸāĻžāĨ¤ āĻāĻ–āĻžāύ⧇ āχāωāϜāĻžāϰāϰāĻž āĻšāĻžāϰāĻžāύ⧋ āĻŦāĻž āĻĒāĻžāĻ“ā§ŸāĻž āϕ⧋āύ⧋ āĻŦāĻ¸ā§āϤ⧁ āĻĒā§‹āĻ¸ā§āϟ āĻ•āϰāϤ⧇ āĻĒāĻžāϰāĻŦ⧇āύ āĻāĻŦāĻ‚ āĻ…āĻ¨ā§āϝāϰāĻž āϤāĻž āĻĻ⧇āϖ⧇ āϝ⧋āĻ—āĻžāϝ⧋āĻ— āĻ•āϰāϤ⧇ āĻĒāĻžāϰāĻŦ⧇āύāĨ¤

## 🔗 Live URL
[👉 View the Live Website](https://beautiful-marigold-d08b9c.netlify.app/)

## 📸 Screenshot
![WhereIsIt Screenshot](./screenshot.png)

## đŸ› ī¸ Main Technologies Used
- React
- Vite
- Firebase
- TailwindCSS
- DaisyUI

## 🚀 Core Features
- āϏāĻšāϜ āĻ“ āĻĒāϰāĻŋāĻˇā§āĻ•āĻžāϰ āχāωāϜāĻžāϰ āχāĻ¨ā§āϟāĻžāϰāĻĢ⧇āϏ
- āφāĻ˛ā§āĻŸā§āϰāĻž āĻĢāĻžāĻ¸ā§āϟ āϞ⧋āĻĄāĻŋāĻ‚ āϟāĻžāχāĻŽ (Vite āĻāϰ āĻŽāĻžāĻ§ā§āϝāĻŽā§‡)
- āϏāĻŽā§āĻĒā§‚āĻ°ā§āĻŖ āϰ⧇āϏāĻĒāĻ¨ā§āϏāĻŋāĻ­ āĻĄāĻŋāϜāĻžāχāύ
- Firebase Authentication āϏāĻžāĻĒā§‹āĻ°ā§āϟ
- React Tooltip āĻĻāĻŋā§Ÿā§‡ āχāύāĻĢāϰāĻŽā§‡āϟāĻŋāĻ­ āĻšā§‹āĻ­āĻžāϰ āϟāĻŋāĻĒāϏ
- React Simple Typewriter āĻĻāĻŋā§Ÿā§‡ āϟāĻžāχāĻĒāĻŋāĻ‚ āĻāύāĻŋāĻŽā§‡āĻļāύ
- React Toastify āĻĻāĻŋā§Ÿā§‡ āϰāĻŋā§Ÿā§‡āϞāϟāĻžāχāĻŽ āύ⧋āϟāĻŋāĻĢāĻŋāϕ⧇āĻļāύ
- DaisyUI āĻ“ TailwindCSS āĻĻāĻŋā§Ÿā§‡ āφāĻ•āĻ°ā§āώāĻŖā§€ā§Ÿ UI

## đŸ“Ļ Dependencies Used
- [`@lottiefiles/dotlottie-react`](https://www.npmjs.com/package/@lottiefiles/dotlottie-react) – Lottie āĻāύāĻŋāĻŽā§‡āĻļāύ āĻŦā§āϝāĻŦāĻšāĻžāϰ⧇āϰ āϜāĻ¨ā§āϝ
- [`@tailwindcss/vite`](https://www.npmjs.com/package/@tailwindcss/vite) – Vite āĻāϰ āϏāĻžāĻĨ⧇ TailwindCSS āχāĻ¨ā§āϟāĻŋāĻ—ā§āϰ⧇āĻļāύ⧇āϰ āϜāĻ¨ā§āϝ
- [`axios`](https://www.npmjs.com/package/axios) – API āĻ•āϞ⧇āϰ āϜāĻ¨ā§āϝ Lightweight HTTP client
- [`firebase`](https://www.npmjs.com/package/firebase) – āχāωāϜāĻžāϰ āĻ…āĻĨ⧇āĻ¨ā§āϟāĻŋāϕ⧇āĻļāύ āĻ“ āĻĄā§‡āϟāĻž āĻŦā§āϝāĻŦāĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϜāĻ¨ā§āϝ
- [`motion`](https://www.framer.com/motion/) – React Animation āϞāĻžāχāĻŦā§āϰ⧇āϰāĻŋ (Framer Motion āĻ­āĻŋāĻ¤ā§āϤāĻŋāĻ•)
- [`react`](https://reactjs.org/) – Core React āϞāĻžāχāĻŦā§āϰ⧇āϰāĻŋ
- [`react-dom`](https://reactjs.org/docs/react-dom.html) – React āĻ•āĻŽā§āĻĒā§‹āύ⧇āĻ¨ā§āϟ āϰ⧇āĻ¨ā§āĻĄāĻžāϰ āĻ•āϰāĻžāϰ āϜāĻ¨ā§āϝ
- [`react-router-dom`](https://reactrouter.com/) – SPA āϰāĻžāωāϟāĻŋāĻ‚ āĻŦā§āϝāĻŦāĻ¸ā§āĻĨāĻžāĻĒāύāĻžāϰ āϜāĻ¨ā§āϝ
- [`react-toastify`](https://fkhadra.github.io/react-toastify/) – āχāωāϜāĻžāϰ āύ⧋āϟāĻŋāĻĢāĻŋāϕ⧇āĻļāύ⧇āϰ āϜāĻ¨ā§āϝ
- [`react-icons`](https://react-icons.github.io/react-icons/) – āφāχāĻ•āύ āϞāĻžāχāĻŦā§āϰ⧇āϰāĻŋ
- [`react-tooltip`](https://react-tooltip.com/) – āĻšā§‹āĻ­āĻžāϰ āϟ⧁āϞāϟāĻŋāĻĒ āĻĻ⧇āĻ–āĻžāύ⧋āϰ āϜāĻ¨ā§āϝ
- [`react-simple-typewriter`](https://www.npmjs.com/package/react-simple-typewriter) – āϟāĻžāχāĻĒāĻŋāĻ‚ āĻāύāĻŋāĻŽā§‡āĻļāύ āχāĻĢ⧇āĻ•ā§āĻŸā§‡āϰ āϜāĻ¨ā§āϝ
- [`tailwindcss`](https://tailwindcss.com/) – Utility-first CSS framework
- [`daisyui`](https://daisyui.com/) – TailwindCSS āĻāϰ āϜāĻ¨ā§āϝ UI āĻ•āĻŽā§āĻĒā§‹āύ⧇āĻ¨ā§āϟ āĻĢā§āϰ⧇āĻŽāĻ“ā§ŸāĻžāĻ°ā§āĻ•

- ---

## âš™ī¸ Installation & Setup

### đŸ“Ĩ Clone Repositories

# Clone Frontend
```bash
git clone https://github.com/Programming-Hero-Web-Course11/b11a11-client-side-CodesWithshahid.git
cd b11a11-client-side-CodesWithshahid
npm install
npm run dev
```
# Clone Backend
```bash
git clone https://github.com/Programming-Hero-Web-Course11/b11a11-server-side-CodesWithshahid.git
cd b11a11-server-side-CodesWitshahid
npm install
npm run dev
```

---

## 🔒 Environment Variables

### 🔹 Client (.env)

```env
VITE_API_KEY=your_firebase_key
VITE_AUTH_DOMAIN=your_firebase_auth
VITE_PROJECT_ID=your_project_id
VITE_STORAGE_BUCKET=your_storage_bucket
VITE_MESSAGING_SENDER_ID=your_sender_id
VITE_APP_ID=your_app_id
VITE_API_URL=https://backend-eta.vercel.app
```

### 🔹 Server (.env)

```env
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
VITE_FIREBASE_PROJECT_ID=your_firebase_project_id
VITE_BACKEND_URL=http://localhost:5000

```

---

## 📤 Image Upload

- Users can upload product images using Imgbb
- Supported on both **Add** and **Update** forms
- Upload triggered through a secure backend API

---

## 🚀 Deployment

### 🔹 Frontend (Firebase)

```bash
npm run build
firebase deploy
```

### 🔹 Backend (Vercel Serverless)

- Routes inside `/api/` folder
- Export handlers using CommonJS/ES6
- Follow [Vercel Docs](https://vercel.com/docs/functions) for structure

---

## đŸ§Ē Testing

- Backend routes tested via Postman
- Firebase test users used for auth
- UI feedback tested via forms, toasts, and edge cases

---

## đŸ“Ģ Contact

📧 Email: [shaahid.045@gmail.com](mailto:shaahid.045@gmail.com)
🔗 LinkedIn: [Shahid Islam](https://linkedin.com/in/shaahid-cp)

---

## 🧑‍🎓 Author

Made with đŸ’ģ by **Md. Shahid Islam**
Lost & Find Project Š 2025

---