Skip to content

piolonrqz/notes-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

105 Commits
 
 
 
 
 
 
 
 

Repository files navigation

📝 Notes App - Team JKWELEYN

Project Status License

A Hybrid Web3 Notes Application built by Team JKWELEYN that combines the speed of Web2 with the permanence and ownership of the Cardano blockchain.

image

🚀 Features

  • 📂 Standard Features - Create, edit, delete, archive, and search/filter notes.
  • 🔐 Zero-Knowledge Auth - Login securely using only your Cardano Wallet (Lace/Nami).
  • ⛓️ Blockchain Permanence - Every note is cryptographically signed and stored on the Cardano blockchain (Preview Network).
  • Optimistic UI - Instant save functionality using a local MongoDB cache while the blockchain confirms in the background.
  • 📦 Smart Chunking - Automatically splits long notes into 64-byte chunks to fit Cardano metadata standards.
  • 🔍 Real-Time Sync - Background workers verify transaction status via Blockfrost API.

🛠️ Tech Stack

Blockchain & Web3

  • Cardano Preview Network - Public ledger for note permanence.
  • MeshSDK - Transaction building and wallet integration.
  • Blockfrost API - Blockchain data verification service.
  • CIP-30 Wallets - Support for Lace, Nami, Eternl, etc.

Frontend

  • React (Vite) - Fast, modern UI library.
  • TailwindCSS - Responsive styling.
  • Lucide React - Iconography.

Backend

  • Node.js & Express - API Server.
  • MongoDB - NoSQL database
  • Mongoose - MongoDB object modeling

🚦 Getting Started

Prerequisites

Make sure you have the following installed:

  • Node.js (v18+)
  • MongoDB (Local or Atlas)
  • Cardano Wallet (Lace or Nami) set to Preview Testnet.
  • Blockfrost Project ID (Preview Network).

Installation

  1. Clone the repository

    git clone https://github.com/your-username/notes-app.git
    cd notes-app
  2. Backend Setup

    cd backend
    npm install
  3. Create environment file

    # Create .env file in backend directory
    touch .env
  4. Frontend Setup

    cd ../frontend
    npm install
  5. Start MongoDB (if using local MongoDB)

    # Windows
    net start MongoDB
    
    # macOS/Linux
    sudo systemctl start mongod

Running the Application

  1. Start the backend server

    cd backend
    npm run dev

    Backend will run on http://localhost:5000

  2. Start the frontend development server

    cd frontend
    npm run dev

    Frontend will run on http://localhost:5173

👥 Team Jakwelin

Profile Name                    GitHub Username           
Jestopher Dela Torre     @JeckTupir
Piolo Frances Enriquez      @piolonrqz
Darwin Darryl Largoza      @Dadaisuk1 
  Nathan Rener Malagapo      @sytrusz     
Xyrill Dereck Canete        @Amarok1214 

📝 License

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages