Skip to content

Latest commit

 

History

History
221 lines (155 loc) · 7.29 KB

File metadata and controls

221 lines (155 loc) · 7.29 KB

<markdown

Typing SVG

License Node React MongoDB Status


🧠 What is 2nd Brain?

"Your mind is for having ideas, not holding them." – David Allen

2nd Brain is a personal knowledge management platform that lets you capture, organize, and share content from across the internet — all in one place. Save Twitter threads, YouTube videos, Instagram posts, and more. Categorize them your way. Share your entire knowledge base with a single link.

Think of it as your digital memory — always organized, always accessible.


✨ Features

Feature Description
🔐 Secure Auth JWT-based sign up & login
📌 Embed Posts Save Twitter, YouTube, Instagram & more
🗂️ Categorization Organize content into custom categories
🧠 View Brain Visualize your entire knowledge base
🔗 Share Brain One link to share everything with anyone
📱 Responsive UI Works seamlessly on all devices

🛠️ Tech Stack

Frontend

React TypeScript TailwindCSS

Backend

Node.js Express.js JWT

Database & DevOps

MongoDB Docker Git


🏗️ Architecture

2nd-brain/ ├── 📁 frontend/ # React + TypeScript app │ ├── src/ │ │ ├── components/ # Reusable UI components │ │ ├── pages/ # Route-level pages │ │ ├── hooks/ # Custom React hooks │ │ ├── context/ # Auth & global state │ │ └── utils/ # Helper functions │ └── package.json │ ├── 📁 backend/ # Node.js + Express API │ ├── src/ │ │ ├── routes/ # API route handlers │ │ ├── controllers/ # Business logic │ │ ├── models/ # MongoDB schemas │ │ ├── middleware/ # Auth & error middleware │ │ └── config/ # DB & env config │ └── package.json │ └── README.md


⚡ Quick Start

Prerequisites

Make sure you have these installed:

  • Node.js
  • MongoDB
  • Git

1️⃣ Clone the Repository

git clone https://github.com/your-username/2nd-brain.git
cd 2nd-brain

2️⃣ Backend Setup

cd backend
npm install

Create a .env file in the /backend directory:

PORT=5000
MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_super_secret_key
NODE_ENV=development

Start the backend server:

npm run dev

🟢 Server running at http://localhost:5000

3️⃣ Frontend Setup

cd ../frontend
npm install
npm start

🌐 App running at http://localhost:3000


📖 Usage Guide

📝 Sign up for a new account (or log in) ➕ Click "Add Content" and paste any social media URL 🗂️ Assign a category (e.g. Learning, Inspiration, Dev) 🧠 Navigate to "My Brain" to see all saved content 🔗 Hit "Share Brain" to generate your public link 🚀 Share the link — anyone can now browse your Brain!


🔌 API Reference

Method Endpoint Description Auth
POST /api/auth/signup Register new user
POST /api/auth/login Login & get JWT token
GET /api/content Get all user content
POST /api/content Add new content
DELETE /api/content/:id Delete content item
GET /api/brain/share Get shareable link
GET /api/brain/:shareId View shared brain

🗺️ Roadmap

  • User authentication (JWT)
  • Save & embed social media posts
  • Content categorization
  • View Brain dashboard
  • Shareable Brain link
  • 🤖 AI-based auto-categorization
  • 🔍 Full-text search across saved content
  • 🌙 Dark mode & customizable themes
  • 📱 Mobile app (React Native)
  • 🔔 Browser extension to save content on the go
  • 📊 Analytics — most saved topics, engagement stats
  • 🤝 Collaborative brains (shared workspaces)

🤝 Contributing

Contributions are what make open source amazing! Here's how to get started:

# 1. Fork the project
# 2. Create your feature branch
git checkout -b feature/amazing-feature

# 3. Commit your changes
git commit -m "feat: add amazing feature"

# 4. Push to the branch
git push origin feature/amazing-feature

# 5. Open a Pull Request 🎉

Please read our Contributing Guidelines and follow the Code of Conduct.


📄 License

Distributed under the MIT License. See LICENSE for more information.


⭐ If you found this useful, please star the repo!

Star History Chart

Built with ❤️ by Akshay