Skip to content

ANIRUDH-333/daily-scribbles-vaulted

Repository files navigation

Daily Scribbles ๐Ÿ“”

A GitHub-powered personal diary app that stores your daily entries as markdown files in your own repository.

Daily Scribbles Banner React TypeScript Vite

๐ŸŒŸ Vision: Building Your Digital Memory

In an era where AI is becoming increasingly sophisticated, imagine having a digital clone that truly understands youโ€”your thoughts, your journey, your patterns, your dreams. Daily Scribbles is more than just a diary app; it's the foundation for creating your future AI self.

๐Ÿง  Why This Matters

Every diary entry you write becomes a training data point for your future digital clone. Unlike social media posts or scattered notes, Daily Scribbles creates a structured, chronological, and deeply personal dataset that captures:

  • Your authentic voice - How you express yourself when no one's watching
  • Your thought patterns - How you process experiences and solve problems
  • Your emotional journey - Your reactions, moods, and growth over time
  • Your personal context - The details that make you uniquely you

๐Ÿš€ The Future We're Building

Imagine being able to:

  • Delegate tasks to an AI that thinks like you do
  • Get advice from an AI trained on years of your own wisdom
  • Preserve your legacy for future generations
  • Scale your presence while maintaining your authentic voice

By storing your entries as markdown files in GitHub, you maintain complete ownership and control over this invaluable dataset. No corporate AI will train on your thoughts without permission. No platform can lock away your memories behind a paywall. This is your data, your story, your future digital self.

๐Ÿ”ฎ Start Today, Shape Tomorrow

Every entry you write today is an investment in your digital future. Start building your personal dataset now, and when the technology catches up, you'll have years of rich, authentic content ready to bring your digital clone to life.

Your journey to digital immortality starts with a single diary entry.


โœจ Features

  • ๐Ÿ“ Beautiful Writing Experience - Clean, distraction-free interface for daily journaling
  • ๐Ÿ” GitHub-Powered Storage - All entries stored as markdown files in your own GitHub repository
  • ๐Ÿš€ Zero Backend - Pure client-side application, no servers or databases to manage
  • ๐Ÿ”’ Complete Privacy - Your data stays in your browser and GitHub only
  • ๐Ÿ“– View Past Entries - Browse and read all your previous diary entries
  • ๐ŸŽจ Mood Tracking - Track your emotional state with custom moods
  • ๐Ÿ“… Organized by Date - Entries automatically organized in a folder structure: Name/Month-Year/DD-MM-YYYY.md
  • โšก Fast & Lightweight - Built with modern React and Vite for optimal performance

๐Ÿš€ Quick Start

Prerequisites

  • A GitHub account
  • A GitHub repository for storing your diary entries
  • A GitHub Personal Access Token with repo permissions

Getting Started

  1. Visit the App: Daily Scribbles (or run locally - see Development section)

  2. Create a GitHub Personal Access Token:

  3. Configure the App:

    • Click "Start Writing" or "Settings"
    • Enter your configuration:
      • Name: Your name (used for folder structure)
      • Repository URL: https://github.com/username/repository-name
      • Branch: main (or your preferred branch)
      • Personal Access Token: Paste your token from step 2
  4. Start Writing:

    • Write your daily entry with a title
    • Select your mood
    • Choose the date
    • Click "Push to GitHub" to save

๐Ÿ“‚ How It Works

File Structure

Your diary entries are stored in this format:

repository/
โ”œโ”€โ”€ YourName/
โ”‚   โ”œโ”€โ”€ January-2025/
โ”‚   โ”‚   โ”œโ”€โ”€ 01-01-2025.md
โ”‚   โ”‚   โ”œโ”€โ”€ 02-01-2025.md
โ”‚   โ”‚   โ””โ”€โ”€ ...
โ”‚   โ”œโ”€โ”€ February-2025/
โ”‚   โ”‚   โ””โ”€โ”€ ...
โ”‚   โ””โ”€โ”€ ...

Entry Format

Each entry is saved as a markdown file:

# My Amazing Day

**Date:** 20/01/2025
**Mood:** happy

---

Today was an incredible day! I learned something new and made great progress on my project...

Architecture

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚   React App     โ”‚
โ”‚  (Your Browser) โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
         โ”‚
         โ”‚ GitHub API
         โ”‚
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ–ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚  GitHub Repo    โ”‚
โ”‚  (Your Data)    โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
  • No Backend: Everything runs in your browser
  • Direct GitHub Commits: Uses GitHub API to create/update files
  • Local Storage: Configuration saved in browser (never leaves your device)

๐Ÿ› ๏ธ Technology Stack

  • Frontend: React 18.3.1 with TypeScript
  • Build Tool: Vite 5.4.1
  • UI Components: shadcn/ui (Radix UI + Tailwind CSS)
  • Routing: React Router DOM 6.26.2
  • Form Management: React Hook Form + Zod
  • Styling: Tailwind CSS 3.4.11
  • Icons: Lucide React
  • Date Handling: date-fns

๐Ÿ’ป Local Development

Installation

# Clone the repository
git clone https://github.com/Anirudh-R-2506/daily-scribbles-vaulted.git
cd daily-scribbles-vaulted

# Install dependencies
npm install

# Start development server
npm run dev

The app will be available at http://localhost:8080

Build for Production

# Build the project
npm run build

# Preview production build
npm run preview

๐Ÿ” Security & Privacy

Data Privacy

  • โœ… Your data never leaves your control - stored only in your GitHub repository
  • โœ… No analytics or tracking - we don't collect any data
  • โœ… No third-party services - direct communication with GitHub only
  • โœ… Local configuration storage - settings saved in browser's localStorage

Security Best Practices

  1. Token Security:

    • Never share your Personal Access Token
    • Use tokens with minimal required permissions (repo only)
    • Rotate your tokens periodically
    • Revoke unused tokens
  2. Repository Privacy:

    • Keep your diary repository private
    • Don't commit sensitive information
    • Review your entries before pushing

๐Ÿ“ Use Cases

  • Personal Journaling: Daily reflections and thoughts
  • Mood Tracking: Monitor emotional patterns over time
  • Goal Tracking: Document your progress and achievements
  • Gratitude Journal: Daily gratitude entries
  • Dream Journal: Record and analyze your dreams
  • Travel Journal: Document your adventures

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development Workflow

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Commit your changes: git commit -m 'Add amazing feature'
  4. Push to the branch: git push origin feature/amazing-feature
  5. Open a Pull Request

๐Ÿ“„ License

This project is open source and available under the MIT License.

๐Ÿ™ Acknowledgments

  • Built with React
  • UI components from shadcn/ui
  • Icons by Lucide
  • Inspired by the idea of owning your own data

๐Ÿ“ง Support

If you encounter any issues or have questions:

  1. Check the Issues page
  2. Create a new issue if needed

๐Ÿ—บ๏ธ Roadmap

  • GitHub-powered storage
  • View past entries
  • Mood tracking
  • Beautiful landing page
  • Markdown editor with live preview
  • Search and filter entries
  • Export entries (PDF, JSON)
  • Mood analytics dashboard
  • Calendar view
  • Tags and categories
  • Image support
  • Encryption for sensitive entries
  • Mobile app (PWA)

Made with โค๏ธ by developers who believe in data ownership

Star โญ this repository if you find it useful!

About

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages