SaveBook

A modern web application for note-taking and knowledge management built with Next.js.

✨ Features

• Modern UI: Clean and responsive design for optimal user experience
• Note Organization: Create, edit, and organize your notes efficiently
• Fast Performance: Built on Next.js for optimal loading and rendering
• Responsive Design: Works seamlessly across desktop, tablet, and mobile devices

📋 Prerequisites

• Node.js 18.x or later
• npm, yarn, pnpm, or bun

🚀 Getting Started

Installation

1. Clone the repository:

   git clone https://github.com/HarshYadav152/SaveBook.git
   cd SaveBook/savebook

2. Install dependencies:

   npm install

3. Create a .env.local file in the root directory based on .env.local.example and set up your environment variables.

Development

Start the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Building for Production

npm run build

Running Production Build

npm start

📁 Project Structure

notebook/
├── .github/           # GitHub templates for issues and PRs
├── .next/             # Next.js build output
  savebook
   ├── app/               # Application routes and pages
   ├── components/        # Reusable React components
   ├── context/           # React context for state management
   ├── lib/               # Utility functions and shared code
   ├── public/            # Static assets
   ├── .env.local         # Environment variables (not in git)
   ├── .gitignore         # Git ignore file
   └── package.json       # Project dependencies and scripts
├── CODE_OF_CONDUCT.md # Community guidelines
├── CONTRIBUTING.md    # Contribution guidelines
├── LICENSE            # Project license
├── README.md          # Project documentation
├── SECURITY.md        # Security policies

🧪 Testing

-- soon

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details on how to submit pull requests, report issues, and suggest enhancements.

All contributors are expected to follow our Code of Conduct.

🔒 Security

If you discover a security vulnerability, please follow our Security Policy for responsible disclosure.

📄 License

This project is licensed under the MIT License.

🙏 Acknowledgments

• Next.js - The React framework for production
• Geist Font - Modern and minimal typeface

📞 Support

For questions and support, please open an issue or contact the maintainers.

Project Mentor (Lead Maintainer & Core Developer) : Harsh Yadav - SaveBook

Project Admin (ECWoC26) : Vinay Kumar - SaveBook

---

Built with ❤️ using Next.js