Skip to content

Commit e5a9000

Browse files
committed
📝doc: Añadido readme
1 parent d2070e9 commit e5a9000

2 files changed

Lines changed: 69 additions & 914 deletions

File tree

README.md

Lines changed: 69 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,82 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
# byteTasks 🚀
22

3-
## Getting Started
3+
> **Your Tasks. Your Drive. 100% Privacy.**
44
5-
First, run the development server:
5+
![byteTasks Banner](https://via.placeholder.com/1200x400?text=byteTasks+Preview)
66

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
7+
**byteTasks** is a modern, privacy-first task management application that lives entirely in your browser. It syncs your data directly to your personal **Google Drive**, ensuring you own your data completely. No third-party servers, no tracking, just you and your tasks.
168

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
9+
## ✨ Features
1810

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
11+
### 🔒 Privacy & Storage
2012

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
13+
- **Google Drive Sync**: Seamlessly syncs your tasks to a private JSON file in your Google Drive.
14+
- **Guest Mode**: Use the app locally without an account. Data stays in your browser's LocalStorage.
15+
- **Frontend-Only**: Authentication and data handling happen directly between you and Google.
2216

23-
## Learn More
17+
### 🎨 User Experience
2418

25-
To learn more about Next.js, take a look at the following resources:
19+
- **Beautiful UI**: Built with a stunning glassmorphism design using **daisyUI** and **TailwindCSS**.
20+
- **Theming**: Choose from a variety of vibrant themes (Cyberpunk, Retro, Synthwave, and more).
21+
- **Smooth Animations**: Enjoy fluid transitions and interactions.
22+
- **Responsive**: Fully optimized for Desktop and Mobile.
23+
- **Gestures**: Swipe from the right edge on mobile to open the settings drawer.
2624

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
25+
### ⚡ Productivity
2926

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
27+
- **Keyboard Shortcuts**: Power user? Control your tasks without leaving the keyboard.
28+
- **Drag & Drop**: Reorder tasks effortlessly.
29+
- **Bi-lingual**: Native support for **English** 🇺🇸 and **Spanish** 🇪🇸.
3130

32-
## Deploy on Vercel
31+
## 🛠️ Tech Stack
3332

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
33+
- **Framework**: [Next.js 15+ (App Router)](https://nextjs.org/)
34+
- **Styling**: [TailwindCSS](https://tailwindcss.com/) & [daisyUI](https://daisyui.com/)
35+
- **Icons**: [Lucide React](https://lucide.dev/)
36+
- **State Management**: React Context + Hooks
37+
- **Persistence**: Google Drive API v3 & IndexedDB/LocalStorage
3538

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
39+
## 🚀 Getting Started
40+
41+
### Prerequisites
42+
43+
You will need **Node.js 18+** and a **Google Cloud Project** with the Drive API enabled.
44+
45+
### Installation
46+
47+
1. **Clone the repository**
48+
49+
```bash
50+
git clone https://github.com/yourusername/byteTasks.git
51+
cd byteTasks
52+
```
53+
54+
2. **Install dependencies**
55+
56+
```bash
57+
npm install
58+
```
59+
60+
3. **Environment Setup**
61+
Create a `.env.local` file in the root directory and add your Google Cloud credentials:
62+
63+
```env
64+
NEXT_PUBLIC_GOOGLE_CLIENT_ID=your_client_id.apps.googleusercontent.com
65+
NEXT_PUBLIC_GOOGLE_API_KEY=your_api_key
66+
```
67+
68+
4. **Run the development server**
69+
70+
```bash
71+
npm run dev
72+
```
73+
74+
5. Open [http://localhost:3000](http://localhost:3000) in your browser.
75+
76+
## 🤝 Contributing
77+
78+
Contributions are welcome! Please feel free to submit a Pull Request.
79+
80+
## 📄 License
81+
82+
This project is open source and available under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)