prathameshdukare commited on
Commit
fbc2187
Β·
verified Β·
1 Parent(s): 7526ec1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +122 -8
README.md CHANGED
@@ -1,10 +1,124 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: README
3
- emoji: 🐒
4
- colorFrom: yellow
5
- colorTo: pink
6
- sdk: static
7
- pinned: false
8
- ---
9
 
10
- Edit this `README.md` markdown file to author your organization card.
 
 
 
1
+ # πŸš€ Acceleration
2
+
3
+ > **Save and rediscover what matters, instantly.**
4
+
5
+ Acceleration is a modern, full-stack productivity tool that helps knowledge workers save, organize, and rediscover their bookmarks and ideas in one beautiful, intuitive space.
6
+
7
+ ## ✨ Features
8
+
9
+ - **Smart Bookmarking**: Save links with automatic metadata extraction
10
+ - **Beautiful Organization**: Organize bookmarks with collections and tags
11
+ - **Multiple Ways to Save**: Browser extension, web interface, and context menu
12
+ - **Fast Search**: Find what you need instantly with powerful search
13
+ - **Cross-Platform**: Works seamlessly across web and browser extension
14
+ - **Modern UI**: Beautiful, responsive design built with modern technologies
15
+
16
+ ## 🌐 Live Demo & Links
17
+
18
+ - **🌐 Website**: [https://getacceleration.com](https://getacceleration.com)
19
+ - **πŸ”Œ Chrome Extension**: [Install from Chrome Web Store](https://chromewebstore.google.com/detail/acceleration/bhfaaekogleafogfpiahllhgnkbogaoj)
20
+ - **πŸ“± Web App**: [https://getacceleration.com/home](https://getacceleration.com/home)
21
+
22
+ ## πŸ—οΈ Architecture
23
+
24
+ Acceleration is built as a modern full-stack application with three main components:
25
+
26
+ ### 1. Web Application (`/web`)
27
+
28
+ - **Framework**: Next.js 14 with TypeScript
29
+ - **Styling**: Tailwind CSS with shadcn/ui components
30
+ - **Authentication**: NextAuth.js with Google OAuth
31
+ - **Deployment**: Vercel-ready configuration
32
+ - **Features**:
33
+ - Beautiful landing page with gradient design
34
+ - Responsive bookmark management interface
35
+ - Real-time search and filtering
36
+ - Collection and tag organization
37
+
38
+ ### 2. Serverless Backend (`/serverless`)
39
+
40
+ - **Runtime**: Cloudflare Workers
41
+ - **Framework**: Hono.js for API routes
42
+ - **Database**: Prisma with Cloudflare D1
43
+ - **Authentication**: JWT-based auth system
44
+ - **Features**:
45
+ - RESTful API for bookmark management
46
+ - Automatic metadata extraction from URLs
47
+ - User authentication and session management
48
+ - Real-time data synchronization
49
+
50
+ ### 3. Browser Extension (`/extension`)
51
+
52
+ - **Framework**: React with TypeScript
53
+ - **Build Tool**: Vite with CRXJS plugin
54
+ - **Styling**: Tailwind CSS
55
+ - **Features**:
56
+ - Beautiful new tab replacement
57
+ - Context menu integration
58
+ - Direct bookmark saving
59
+ - Real-time clock and weather
60
+ - Customizable dashboard
61
+
62
+ ## πŸ› οΈ Tech Stack
63
+
64
+ ### Frontend
65
+
66
+ - **React 18** with TypeScript
67
+ - **Next.js 14** for web application
68
+ - **Tailwind CSS** for styling
69
+ - **shadcn/ui** for component library
70
+ - **Framer Motion** for animations
71
+ - **Lucide React** for icons
72
+
73
+ ### Backend
74
+
75
+ - **Cloudflare Workers** for serverless functions
76
+ - **Hono.js** for API framework
77
+ - **Prisma** for database ORM
78
+ - **Cloudflare D1** for database
79
+ - **JWT** for authentication
80
+
81
+ ### Development Tools
82
+
83
+ - **TypeScript** for type safety
84
+ - **ESLint** for code linting
85
+ - **Vite** for fast development
86
+ - **Wrangler** for Cloudflare Workers deployment
87
+
88
+ ## About application
89
+
90
+ #### Bookmark Management
91
+
92
+ - Automatic metadata extraction from URLs
93
+ - Support for collections and tags
94
+ - Real-time search and filtering
95
+ - Beautiful card-based interface
96
+
97
+ #### Browser Integration
98
+
99
+ - New tab replacement with productivity dashboard
100
+ - Context menu for quick bookmarking
101
+ - Seamless sync between extension and web app
102
+
103
+ #### User Experience
104
+
105
+ - Responsive design for all devices
106
+ - Dark/light theme support
107
+ - Smooth animations and transitions
108
+ - Intuitive navigation
109
+
110
+ ## πŸ‘¨β€πŸ’» Author
111
+
112
+ **Prathamesh Dukare**
113
+
114
+ - **GitHub**: [@prathameshdukare](https://github.com/prathameshdukare)
115
+ - **LinkedIn**: [Prathamesh Dukare](https://linkedin.com/in/prathameshdukare)
116
+ - **Website**: [Website](https://prathame.sh)
117
+ - **Peerlist**: [Peerlist.io/prathamesh](https://peerlist.io/prathamesh)
118
+ - **Peerlist**: [prathameshTwits](https://x.com/prathameshTwits)
119
+
120
  ---
 
 
 
 
 
 
 
121
 
122
+ **Made with ❀️ in India**
123
+
124
+