Skip to content

Latest commit

 

History

History
104 lines (90 loc) · 2.95 KB

README.md

File metadata and controls

104 lines (90 loc) · 2.95 KB
Raw

Notepod.xyz 📝

Notepod.xyz is a modern, user-friendly app designed to help you manage your life. Easily save todos, notes, and passwords, and stay organized with our intuitive interface. Accidentally deleted something? Don’t worry! Your deleted items are stored safely in a "Deleted" tab for a few days before permanent removal.

Alt: homepage

🚀 Features

  • 📓 Organize Your Notes

    • Save and edit your notes effortlessly.
    • Rich text formatting
    • Categorize with tags

  • ✅ Track Todos

    • Prioritize tasks
    • Set due dates
    • Track completion status

  • 🔒 Secure Password Management

    • Quick access to frequently used credentials
    • COMING SOON: Password strength Indicators
    • Encrypted password storage

  • 🗑️ Deleted Tab

    • Temporary storage for deleted Items
    • Easy restoration process
    • Automatic cleanup after retention period

Tech Stack

  • 👨‍💻 Frontend

    • React
    • TypeScript
    • Vite
    • Vanilla CSS for styling
    • context API for state management
    • Graphql for fetching and modifying data between the api and client app

📝 Prerequisite

Before you begin please checkout the backend README.md

  • Node.js(v16 or higher)
  • npm, pnpm or yarn

🚀 Getting started

  1. Clone the repository

     # Install frontend dependencies
 cd frontend
 npm install

  2. Start development server

    npm run dev

🧱 Project Strucure

notepod.xyz/
├── frontend/
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── hooks/
│   │   ├── utils/
│   │   └── context/
│   │   └── maint.tsx
│   │   └── App.tsx
│   │   └── vite-env.d.ts
│   ├── public/
│   ├── .gitignore
│   └── eslint.config.js
│   └── index.html
│   └── package.json
│   └── README.md
│   └── tsconfig.json
│   └── tsconfig.app.json
│   └── vite.config.ts

🧪 Testing

cd frontend
npm run test

💥 Deployment

  • Build the frontend: npm run build
  • Deploy the dist folder to your preferred hosting service

🤝 Contribution

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes(git commit -m 'Added some exciting stuff')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a pull request

👏 Acknowledgments

💬 contact