aagmanpal/SaveBook

SaveBook | a digital note saving book

โ˜… 0Forks 0JavaScriptGitHub โ†—Compare

Project website โ†—

README

๐Ÿ“– SaveBook

Empowering your thoughts with a seamless, distraction-free note-taking experience.

SaveBook is a high-performance, modern web application designed for note-taking and knowledge management. Built leveraging the latest Next.js features, it provides a fast, intuitive, and clutter-free environment for organizing your digital life.


๐Ÿ—๏ธ Architecture & Data Flow

Understanding how SaveBook handles data is key for contributors. Here is the high-level architecture of the application:

graph TD
    A[User Interface] -->|Interacts| B(Next.js App Router)
    B -->|Provides State| C{Context API}
    C -->|Persists| D[Local Storage/API]
    B -->|Renders| E[Server/Client Components]
    E -->|Styles| F[Tailwind CSS]
Loading

๐Ÿš€ Quick Start (TL;DR)

Get up and running in less than 2 minutes:

  1. Clone & Enter
git clone [https://github.com/HarshYadav152/SaveBook.git](https://github.com/HarshYadav152/SaveBook.git) && cd SaveBook/savebook
  1. Install Dependencies
npm install
  1. Run Development Server
npm run dev

Tip

Once the server starts, open http://localhost:3000 in your browser to see the app in action!

Note

Using Docker? For a containerized setup with MongoDB included, see our Docker Setup Guide.


๐Ÿ“ Project Structure

Note

The core application logic resides within the savebook/ subdirectory.

SaveBook/
โ”œโ”€โ”€ .github/              # Issue & PR Templates
โ”œโ”€โ”€ savebook/             # <--- MAIN APPLICATION
โ”‚   โ”œโ”€โ”€ app/              # Routes & Pages (Next.js App Router)
โ”‚   โ”œโ”€โ”€ components/       # UI Components (Buttons, Cards, etc.)
โ”‚   โ”œโ”€โ”€ context/          # State Management
โ”‚   โ”œโ”€โ”€ lib/              # Utility & Helper Functions
โ”‚   โ””โ”€โ”€ public/           # Static Assets
โ”œโ”€โ”€ CONTRIBUTING.md       # Contribution Guide
โ””โ”€โ”€ LICENSE               # MIT License

โœจ Features

  • ๐ŸŽจ Modern UI โ€“ Clean and intuitive design focused on reducing distraction.
  • ๐Ÿ“‚ Smart Organization โ€“ Efficient tools for creating, editing, and managing your digital knowledge base.
  • โšก High Performance โ€“ Optimized with Next.js for near-instant load times and smooth transitions.
  • ๐Ÿ“ฑ Fully Responsive โ€“ A seamless, native-like experience across mobile, tablet, and desktop devices.

๐Ÿค Contributing to ECWoC 2026

Important

We are proud to be part of ECWoC 2026! We welcome contributors of all skill levels to help shape the future of SaveBook.

  1. ๐Ÿ” Find an Issue: Check our Issues page for "good first issues."
  2. ๐Ÿ“– Guidelines: Read our Contributing Guidelines to understand our workflow.
  3. ๐Ÿš€ Submit: Fork the repo, make your changes, and open a Pull Request!

๐Ÿ‘ฅ Meet the Team

Role Name GitHub
Project Mentor Harsh Yadav @harshyadav152
Project Admin Vinay Kumar @vinayboss9669

๐ŸŒŸ Show Your Support

Give a โญ๏ธ if this project helped you! Your support means a lot to the maintainers and the ECWoC community.

Built with โค๏ธ by the SaveBook Community

Contributors

HarshYadav152VinayKumar42JackSparrow-BlackPearlavdhut400saiusesgithubAbhijeet-980diksha78devharshrana14-fiheisenberg7519Shivam154CObhoomiieeNitya-003saburi004tanmay019aiKARTIK001-CODERHarishchandra-26Hina7253KarelakingMonasri29-hubSuvam18Ysh2006-ai

Issues