Memoir

Memoir is a collaborative note-taking application that allows users to create, edit, and share notes in real-time. It features seamless collaboration with multi-cursor support and line-by-line locking.

Backend Repository

The backend repository for Memoir can be found here.

Features

• Real-time Collaboration: Edit documents simultaneously with your team.
• AI Summarization: Get AI-generated summaries of your notes.
• Google Calendar Integration: Save events directly to your Google Calendar.
• Permission Management: Share notes with different permission levels (viewer, commenter, editor).
• User Authentication: Secure authentication using Clerk.

Tech Stack

• Frontend: React, TypeScript, Tailwind CSS
• Backend: Node.js, Express (API URL configured in .env.local)
• Real-time: Socket.io
• AI Integration: Custom AI summarization endpoint
• Authentication: Clerk
• Collaboration: Liveblocks, Yjs

Getting Started

1. Clone the repository:

git clone https://github.com/yourusername/memoir.git
cd memoir_client

2. Install dependencies:

npm install

3. Set up environment variables: Create a .env.local file in the root directory and add the following:

VITE_API_URL=http://localhost:8000/
VITE_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
CLERK_SECRET_KEY=your_clerk_secret_key
VITE_GOOGLE_CLIENT_ID=your_google_client_id
VITE_LIVEBLOCKS_TEST_KEY=your_liveblocks_test_key

4. Run the application:

npm run dev

5. Build for production:

npm run build

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the HATI License. 🥷🏼