|
1 |
| -# Nuxt Minimal Starter |
| 1 | +# Vue Todo App Documentation |
| 2 | + |
| 3 | +A feature-rich todo application built with Vue 3, Nuxt, and Pinia for state management. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +### Multiple Todo Lists |
| 8 | +- Create multiple todo lists |
| 9 | +- Switch between lists |
| 10 | +- Delete lists (with confirmation) |
| 11 | +- Persistent storage |
| 12 | +- Responsive sidebar navigation |
| 13 | + |
| 14 | +### Todo Management |
| 15 | +- Add new todos |
| 16 | +- Edit existing todos |
| 17 | +- Mark todos as complete/incomplete |
| 18 | +- Delete individual todos |
| 19 | +- Bulk actions: |
| 20 | + - Complete all todos |
| 21 | + - Uncomplete all todos |
| 22 | + - Delete all todos |
| 23 | + |
| 24 | +### Filtering & Search |
| 25 | +- Filter todos by status: |
| 26 | + - All |
| 27 | + - Active |
| 28 | + - Completed |
| 29 | +- Search todos by title |
| 30 | +- Real-time filtering |
| 31 | + |
| 32 | +### UI/UX Features |
| 33 | +- Responsive design |
| 34 | +- Mobile-friendly navigation |
| 35 | +- Smooth transitions |
| 36 | +- Confirmation dialogs |
| 37 | +- Visual feedback |
| 38 | + |
| 39 | +## Technical Stack |
| 40 | + |
| 41 | +- **Framework**: Vue 3 + Nuxt 3 |
| 42 | +- **State Management**: Pinia |
| 43 | +- **Persistence**: Local Storage |
| 44 | +- **Styling**: Scoped CSS |
| 45 | +- **TypeScript**: Full type safety |
| 46 | + |
| 47 | +## Project Structure |
2 | 48 |
|
3 |
| -Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. |
4 |
| - |
5 |
| -## Setup |
6 |
| - |
7 |
| -Make sure to install dependencies: |
8 |
| - |
9 |
| -```bash |
10 |
| -# npm |
11 |
| -npm install |
12 |
| - |
13 |
| -# pnpm |
14 |
| -pnpm install |
15 |
| - |
16 |
| -# yarn |
17 |
| -yarn install |
18 |
| - |
19 |
| -# bun |
20 |
| -bun install |
| 49 | +``` |
| 50 | +todo-app/ |
| 51 | +├── components/ |
| 52 | +│ ├── TodoInput.vue |
| 53 | +│ ├── TodoItem.vue |
| 54 | +│ ├── TodoList.vue |
| 55 | +│ ├── TodoLists.vue |
| 56 | +│ ├── TodoFilter.vue |
| 57 | +│ ├── TodoActions.vue |
| 58 | +│ └── SearchBar.vue |
| 59 | +├── stores/ |
| 60 | +│ └── todo-store.ts |
| 61 | +├── types/ |
| 62 | +│ └── index.ts |
| 63 | +└── pages/ |
| 64 | + └── index.vue |
21 | 65 | ```
|
22 | 66 |
|
23 |
| -## Development Server |
24 |
| - |
25 |
| -Start the development server on `http://localhost:3000`: |
26 |
| - |
27 |
| -```bash |
28 |
| -# npm |
29 |
| -npm run dev |
30 |
| - |
31 |
| -# pnpm |
32 |
| -pnpm dev |
33 |
| - |
34 |
| -# yarn |
35 |
| -yarn dev |
36 |
| - |
37 |
| -# bun |
38 |
| -bun run dev |
| 67 | +## Component Overview |
| 68 | + |
| 69 | +### TodoInput |
| 70 | +- Handles new todo creation |
| 71 | +- Form validation |
| 72 | +- Clear input after submission |
| 73 | + |
| 74 | +### TodoItem |
| 75 | +- Displays individual todo |
| 76 | +- Edit/Delete actions |
| 77 | +- Completion toggle |
| 78 | +- Double-click to edit |
| 79 | + |
| 80 | +### TodoList |
| 81 | +- Renders todo items |
| 82 | +- Handles todo interactions |
| 83 | +- Empty state handling |
| 84 | + |
| 85 | +### TodoLists |
| 86 | +- Manages multiple lists |
| 87 | +- Create/Delete lists |
| 88 | +- List navigation |
| 89 | +- Todo count per list |
| 90 | + |
| 91 | +### TodoFilter |
| 92 | +- Status filtering |
| 93 | +- Active filter indication |
| 94 | +- All/Active/Completed options |
| 95 | + |
| 96 | +### TodoActions |
| 97 | +- Bulk actions |
| 98 | +- Confirmation dialogs |
| 99 | +- Complete/Uncomplete all |
| 100 | +- Delete all |
| 101 | + |
| 102 | +### SearchBar |
| 103 | +- Real-time search |
| 104 | +- Case-insensitive matching |
| 105 | +- Debounced input handling |
| 106 | + |
| 107 | +## State Management |
| 108 | + |
| 109 | +### Store Structure |
| 110 | +```typescript |
| 111 | +interface State { |
| 112 | + lists: TodoList[]; |
| 113 | + activeListId: number; |
| 114 | + editingId: number | null; |
| 115 | + filter: FilterType; |
| 116 | + searchQuery: string; |
| 117 | +} |
39 | 118 | ```
|
40 | 119 |
|
41 |
| -## Production |
| 120 | +### Persistence |
| 121 | +- Automatic state persistence |
| 122 | +- Local storage based |
| 123 | +- Hydration handling |
42 | 124 |
|
43 |
| -Build the application for production: |
| 125 | +## Responsive Design |
44 | 126 |
|
45 |
| -```bash |
46 |
| -# npm |
47 |
| -npm run build |
| 127 | +### Desktop View |
| 128 | +- Side-by-side lists and todos |
| 129 | +- Full width content area |
| 130 | +- Visible navigation |
48 | 131 |
|
49 |
| -# pnpm |
50 |
| -pnpm build |
51 |
| - |
52 |
| -# yarn |
53 |
| -yarn build |
54 |
| - |
55 |
| -# bun |
56 |
| -bun run build |
57 |
| -``` |
| 132 | +### Mobile View |
| 133 | +- Toggle between lists and todos |
| 134 | +- Hamburger menu navigation |
| 135 | +- Optimized touch targets |
58 | 136 |
|
59 |
| -Locally preview production build: |
| 137 | +## Getting Started |
60 | 138 |
|
61 | 139 | ```bash
|
62 |
| -# npm |
63 |
| -npm run preview |
64 |
| - |
65 |
| -# pnpm |
66 |
| -pnpm preview |
| 140 | +# Install dependencies |
| 141 | +npm install |
67 | 142 |
|
68 |
| -# yarn |
69 |
| -yarn preview |
| 143 | +# Run development server |
| 144 | +npm run dev |
70 | 145 |
|
71 |
| -# bun |
72 |
| -bun run preview |
73 |
| -``` |
| 146 | +# Build for production |
| 147 | +npm run build |
74 | 148 |
|
75 |
| -Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. |
| 149 | +# Preview production build |
| 150 | +npm run preview |
| 151 | +``` |
0 commit comments