ZettaNote

ZettaNote is an open-source note-taking app (in active development) inspired by tools like Notion.
It focuses on Markdown-based notes, real-time collaboration, and flexible organization while remaining lightweight and developer-friendly.

---

🚧 Project Status

This project is currently in the development phase.
Core features are being built and contributions are welcome.

---

✨ Planned Features

• 📝 Notes written with Markdown
• 🔗 Ability to share notes with others
• 📑 Note templates for quick setup
• 🤝 Real-time collaboration (multi-user editing)

---

🛠️ Tech Stack

• Backend: Node.js + Express + MongoDB
• Frontend: React + Material UI

---

🚀 Getting Started

Prerequisites

• Node.js (v18+ recommended)
• MongoDB (local or cloud instance)
• npm or yarn

Backend Setup

1. Clone the repo

   git clone https://github.com/braydenidzenga/zettanote.git
   

2. Install dependencies

    cd ZettaNote/backend
    npm install
   

3. Setup .env file

    save a copy of .env.example as ".env" and fill in the variables
    

4. Run the backend

    npm run dev

Frontend Setup

1. Install dependencies

   cd ZettaNote/frontend
   npm install
   

2. Edit config.js

    update the API_URL to point to your backend instance
   

3. Run the frontend

    npm start
   

Running with Docker

Requirements

• Docker
• MongoDB instance (local or cloud)

1. Clone the repo

   git clone https://github.com/braydenidzenga/zettanote.git
   

2. Edit variables

   cd ZettaNote/backend
   modify the variables in the Dockerfile
   
   cd ZettaNote/frontend
   modify config.js to point to your backend instance
   

3. Build Docker images

    docker build -t zettanote-backend ./backend
    docker build -t zettanote-frontend ./frontend
   

4. Run Docker containers

        docker run -d -p PORT:PORT --name zettanote-backend zettanote-backend
        docker run -d -p 3000:3000 --name zettanote-frontend zettanote-frontend