Skip to content

PRODHOSH/SaveBook

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

355 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

πŸ“– 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 SaveBook through Nexus Spring of Code

Important

We are proud to be part of SaveBook! 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.

Built with ❀️ by the SaveBook Community

About

SaveBook | modern web application designed for note-taking and knowledge management.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 97.6%
  • CSS 2.0%
  • Dockerfile 0.4%