Skip to content

lxw15337674/memox

Repository files navigation

✍️ Memox

A modern and elegant note-taking application

🌟 Features

  • 📝 Quick Notes: Fast and efficient note-taking interface
  • 🔍 Multi-filter Search: Advanced filtering capabilities for easy memo retrieval
  • 📊 Multi-dimensional Statistics: Comprehensive data analysis and visualization
  • 🎨 Share Cards Generation: Create and share beautiful memo cards
  • 📱 Responsive Design: Works seamlessly across desktop and mobile devices
  • 🔄 Data Import/Export: Support for XLSX file import/export
  • 🎯 AI Integration: Smart features powered by AI capabilities
  • 🌓 Dark Mode: Support for both light and dark themes

🛠️ Tech Stack

  • Framework: Next.js 15 with TypeScript
  • UI Components:
  • State Management:
    • Zustand for state management
    • Immer for immutable state updates
  • Database: PostgreSQL with Prisma ORM
  • Utilities:

🚀 Getting Started

Prerequisites

  • Node.js 18+
  • PNPM package manager
  • PostgreSQL database

Installation

  1. Clone the repository
git clone https://github.com/yourusername/memox.git
cd memox
  1. Install dependencies
pnpm install
  1. Configure environment variables Create a .env file in the root directory with the following variables:
DATABASE_URL="your-postgresql-connection-string"
AI_API_KEY="your-ai-api-key"
AI_BASE_URL="your-ai-base-url"
ACCESS_CODE="your-edit-code"
  1. Initialize database
pnpm migrate
  1. Start development server
pnpm dev

Visit http://localhost:3000 to see your application.

🌍 Deployment

Deploy to Vercel

  1. Fork this repository
  2. Create a new project in Vercel
  3. Configure the environment variables in Vercel project settings
  4. Deploy!

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

About

A modern and elegant note-taking application

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages