Skip to content

MKishoreDev/Vyn-Notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

19 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🧠 VynNotes

VynNotes Banner

VynNotes Logo

Write. Think. Win.

Built by M.Kishore β€” a personal AI note-taking project.


πŸš€ Overview

VynNotes is a lightweight AI-powered note-taking app built with Streamlit and MongoDB.

It focuses on:

  • fast note creation
  • clean editing
  • AI-assisted workflows
  • personal productivity without unnecessary complexity

VynNotes is intentionally simple and designed for individual use.


πŸ’‘ Motivation

This project was built to:

  • create a clean note editor for problem solving
  • learn Streamlit and Python UI development
  • experiment with AI-assisted workflows
  • build something practical outside the Telegram bot ecosystem

It is not intended to become a full Notion clone or enterprise workspace.


🌐 Demo

Live App: Vyn-Notes

Personal project β€” built for learning and productivity.


βš™οΈ Tech Stack

  • Python β€” Core logic
  • Streamlit β€” UI framework
  • MongoDB Atlas β€” Cloud database
  • Groq API β€” AI note assistance

✨ Features

  • AI-assisted note editing
  • Persistent MongoDB storage
  • Minimal and distraction-free UI
  • Instant note saving
  • Recent note navigation
  • Markdown downloads
  • Lightweight Streamlit deployment

πŸš€ Local Setup

1. Clone Repository

git clone https://github.com/MKishoreDev/Vyn-Notes.git
cd Vyn-Notes

2. Create Virtual Environment

Windows

python -m venv .venv
.\.venv\Scripts\activate

macOS / Linux

python3 -m venv .venv
source .venv/bin/activate

3. Install Requirements

pip install -r requirements.txt

4. Create .env

Windows

copy .env.example .env

macOS / Linux

cp .env.example .env

5. Configure Environment Variables

Open .env and add:

MONGODB_URI=your_mongodb_uri
MONGODB_DB=vynnotes
MONGODB_NOTES_COLLECTION=notes
MONGODB_CHATS_COLLECTION=chats
GROQ_API_KEY=your_groq_api_key

☁️ Streamlit Cloud Deployment

VynNotes now uses st.secrets for cloud deployment.

Add Secrets in Streamlit Cloud

Go to:

App Settings β†’ Secrets

Add:

MONGODB_URI = "your_mongodb_uri"
GROQ_API_KEY = "your_groq_api_key"

MONGODB_DB = "vynnotes"
MONGODB_NOTES_COLLECTION = "notes"
MONGODB_CHATS_COLLECTION = "chats"

MONGODB_TLS_ALLOW_INVALID_CERTS = false

πŸ”’ Config System

The app supports:

  • local .env development using python-dotenv
  • Streamlit Cloud secrets using st.secrets

Current configuration setup:

import os
from pathlib import Path
from dotenv import load_dotenv
import streamlit as st

BASE_DIR = Path(__file__).resolve().parent
load_dotenv(BASE_DIR / ".env")

MONGODB_URI = st.secrets.get("MONGODB_URI") or os.getenv("MONGODB_URI")
GROQ_API_KEY = st.secrets.get("GROQ_API_KEY") or os.getenv("GROQ_API_KEY")

MONGODB_DB = st.secrets.get("MONGODB_DB", "vynnotes")
MONGODB_TLS_ALLOW_INVALID_CERTS = st.secrets.get(
    "MONGODB_TLS_ALLOW_INVALID_CERTS",
    "false"
).lower() in ("1", "true", "yes")

MONGODB_NOTES_COLLECTION = st.secrets.get(
    "MONGODB_NOTES_COLLECTION",
    "notes"
)

MONGODB_CHATS_COLLECTION = st.secrets.get(
    "MONGODB_CHATS_COLLECTION",
    "chats"
)

▢️ Run App

streamlit run note.py

πŸ—‘οΈ Reset Database

python reset_db.py

This removes all saved notes and chat history.


⚠️ Important Notes

  • Single-user project
  • No authentication system
  • No multi-user support
  • Minimal formatting by design
  • Built for simplicity and learning

The goal is speed and clarity, not feature overload.


🀝 Contributing

Contributions are welcome.

Please preserve the project philosophy:

  • simple
  • lightweight
  • readable
  • easy to maintain

πŸ“Œ Project Status

πŸ› οΈ Personal project β€” actively evolving and improving.


πŸ“œ Philosophy

Keep it simple. Keep it useful.


πŸ“¬ Closing

VynNotes is not a Notion replacement.

It is a lightweight AI note-taking project built for:

  • learning Streamlit
  • experimenting with AI workflows
  • capturing ideas quickly
  • staying productive without complexity

About

Vyn-Notes is a personal note app built with Python and Streamlit, providing lightweight AI-powered note capture and editing. It uses Groq for fast assistance with organization, content improvement, and idea refinement, while staying simple and personal.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages