|
1 | | -# TASKR (A HELPER FINDER APP) |
2 | | -📌 Project Overview |
3 | | -A taskr web application built with: |
4 | | - |
5 | | -Frontend: React + Vite |
6 | | - |
7 | | -Routing: React Router |
8 | | - |
9 | | -Styling: Tailwind CSS |
10 | | - |
11 | | -API: JSONPlaceholder (mock data) , Robohash |
12 | | - |
13 | | -Live Demo: Deployed Link (Add your deployment link here) |
14 | | - |
15 | | -#🚀 Features |
16 | | -✅ Landing Page - Introduction to the app |
17 | | -✅ Find Helper - Displays a list of helpers fetched from an API |
18 | | -✅ Navigation - Smooth scrolling between sections |
19 | | -✅ Authentication Pages - Login & Signup (UI only) |
20 | | - |
21 | | -#🛠️ Installation & Setup |
22 | | -1. Clone the Repository |
23 | | -bash |
24 | | -git clone https://github.com/Adonis-12/taskr.git |
25 | | -cd helper-finder |
26 | | -2. Install Dependencies |
27 | | -bash |
28 | | -npm install |
29 | | -3. Run the Development Server |
30 | | -bash |
31 | | -npm run dev |
32 | | -Open http://localhost:3000 in your browser. |
33 | | - |
34 | | -#4. Build for Production |
35 | | -bash |
36 | | -npm run build |
37 | | - |
38 | | - |
39 | | -#📂 Project Structure |
40 | | -src/ |
41 | | -├── components/ |
42 | | -│ ├── navigation/ # Navigation bar |
43 | | -│ ├── landingPage/ # Hero section |
44 | | -│ ├── findHelper/ # Helper listing |
45 | | -│ ├── footer/ # Footer |
46 | | -│ ├── login/ # Login page |
47 | | -│ └── signup/ # Signup page |
48 | | -├── App.jsx # Main app & router setup |
49 | | -├── main.jsx # Vite entry point |
50 | | -└── styles/ # Global CSS (if any) |
51 | | - |
52 | | - |
53 | | -#🔧 Key Code Implementation |
54 | | -1. Data Fetching (API) |
55 | | -Fetches mock users from JSONPlaceholder |
56 | | - |
57 | | -Handles loading & error states |
58 | | - |
59 | | -#jsx |
60 | | -// Inside Home.jsx |
61 | | -useEffect(() => { |
62 | | - fetch('https://jsonplaceholder.typicode.com/users') |
63 | | - .then((res) => res.json()) |
64 | | - .then((data) => setUsers(data)) |
65 | | - .catch((err) => setError(err)); |
66 | | -}, []); |
67 | | - |
68 | | - |
69 | | -#2. Smooth Scrolling (react-scroll) |
70 | | -Navigation links scroll to sections smoothly |
71 | | - |
72 | | -jsx |
73 | | -<Link to="findhelper-section" smooth={true} duration={500}> |
74 | | - Find Helper |
75 | | -</Link> |
76 | | - |
77 | | - |
78 | | -#3. Routing (React Router) |
79 | | -Handles /, /login, /signup routes |
80 | | - |
81 | | -jsx |
82 | | -const router = createBrowserRouter([ |
83 | | - { path: "/", element: <Home /> }, |
84 | | - { path: "/login", element: <LoginPage /> }, |
85 | | - { path: "/signup", element: <SignupPage /> } |
86 | | -]); |
87 | | - |
88 | | - |
89 | | -#🔗 Dependencies |
90 | | -Package Usage |
91 | | -react Core library |
92 | | -react-router-dom Routing |
93 | | -react-scroll Smooth scrolling |
94 | | -tailwindcss Styling |
95 | | -vite Build tool |
96 | | -📝 How to Contribute |
97 | | -Fork the repository |
98 | | - |
99 | | -Create a new branch (git checkout -b feature/new-feature) |
100 | | - |
101 | | -Commit changes (git commit -m "Add new feature") |
102 | | - |
103 | | -Push to the branch (git push origin feature/new-feature) |
104 | | - |
105 | | -Open a Pull Request |
106 | | - |
107 | | -#📜 License |
108 | | -MIT License - Free to use and modify. |
109 | | - |
110 | | -📬 Contact |
111 | | -Mayank Banga- mayankbanga84@gmail.com |
112 | | - |
113 | | - |
114 | | - |
0 commit comments