🎨 Inscribe

Real-time Collaborative Drawing App

📝 Table of Contents

• ✨ Features
• 🚀 Quick Start
• ⚙️ Installation
• 🔧 Development
• 🧰 Tech Stack
• 🤝 Contributing
• 📝 License
• 📧 Contact
• 🙏 Acknowledgments
• 🌟 Features Coming Soon
• 📊 Stats

✨ Features

🎨 Real-time Collaborative Drawing

• Multi-user Canvas: Draw simultaneously with others in real-time
• Rich Toolset:
  • Multiple brush types (pencil, marker, highlighter)
  • Customizable colors and brush sizes
  • Eraser with adjustable size
  • Undo/Redo functionality
  • Clear canvas option
• Responsive Canvas:
  • Works on all device sizes
  • Smooth zoom and pan functionality
  • Auto-resize on window change

💬 Built-in Chat System

• Real-time messaging
• User presence indicators (online/offline)
• Message history with timestamps
• Typing indicators
• Emoji support
• User mentions

🎨 Modern UI/UX

• Themes:
  • Light and dark mode
  • Custom theme support
  • System preference detection
• Intuitive Interface:
  • Clean, modern design
  • Keyboard shortcuts for power users
  • Tooltips and helpful hints
  • Responsive layout for all devices

🔒 Security & Performance

• Security Features:
  • Input sanitization
  • Rate limiting on API endpoints
  • Secure WebSocket connections (WSS)
  • CORS protection
• Performance Optimizations:
  • Efficient canvas rendering
  • WebSocket connection optimization
  • Lazy loading of assets
  • Client-side caching

🛠 Developer Experience

• Comprehensive API documentation
• Environment-based configuration
• Linting and code formatting
• Detailed logging
• Error tracking integration
• Automated testing suite

🚀 Quick Start

Get started with Inscribe in under 5 minutes:

1. Clone the repository

   git clone https://github.com/Keshabkjha/Inscribe.git
   cd Inscribe

2. Install dependencies

   npm install

3. Set up environment

   cp .env.example .env
   # Edit .env with your configuration

4. Start the development server

   npm run dev

5. Open in browser Visit http://localhost:3000 to start using Inscribe!

🔧 Development

Available Scripts

• npm start - Start the production server
• npm run dev - Start the development server with hot-reload
• npm run prod - Start in production mode
• npm run lint - Run ESLint
• npm run lint:fix - Fix linting issues
• npm run format - Format code with Prettier
• npm test - Run tests (coming soon)

Project Structure

Inscribe/
├── .github/               # GitHub configuration files
│   ├── workflows/         # GitHub Actions workflows
│   └── ISSUE_TEMPLATE/    # Issue templates
├── docs/                  # Documentation files
├── public/                # Static files
│   ├── css/               # Stylesheets
│   ├── js/                # Client-side JavaScript
│   └── images/            # Image assets
├── .editorconfig          # Editor configuration
├── .env.example           # Example environment variables
├── .eslintrc.json         # ESLint configuration
├── .gitignore            # Git ignore rules
├── CHANGELOG.md          # Version history
├── CODE_OF_CONDUCT.md    # Community guidelines
├── CONTRIBUTING.md      # Contribution guide
├── LICENSE              # MIT License
├── package.json         # Project configuration
├── README.md           # Project documentation
├── ROADMAP.md          # Development roadmap
├── SECURITY.md         # Security policy
└── server.js          # Main application file

Inscribe/
├── public/               # Static files
│   ├── index.html        # Main HTML file
│   ├── script.js         # Client-side JavaScript
│   └── styles.css        # Main stylesheet
├── server/               # Server-side code
│   ├── config/          # Configuration files
│   ├── controllers/     # Request handlers
│   ├── models/          # Database models
│   ├── routes/          # API routes
│   └── utils/           # Utility functions
├── test/                # Test files
├── .env.example         # Example environment variables
├── .eslintrc.json       # ESLint configuration
├── .gitignore           # Git ignore file
├── package.json         # Project dependencies and scripts
└── README.md            # Project documentation

Environment Variables

See .env.example for all available environment variables.

🧰 Tech Stack

• Frontend:

  • HTML5 Canvas API
  • Vanilla JavaScript (ES6+)
  • CSS3 with Flexbox/Grid
  • Responsive Design

• Backend:

  • Node.js
  • Express.js
  • Socket.IO
  • MongoDB with Mongoose

• Dev Tools:

  • ESLint
  • Prettier
  • Nodemon
  • Git

🤝 Contributing

We welcome contributions from the community! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Code Style

• Follow existing code style and formatting
• Write meaningful commit messages
• Update documentation as needed
• Add tests for new features

Reporting Issues

Found a bug? Please open an issue with:

• A clear description of the problem
• Steps to reproduce
• Expected vs actual behavior
• Screenshots if applicable

For more details, please check out our Contributing Guide.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

📧 Contact

Keshab Kumar Jha
Email: keshabkumarjha876@gmail.com
GitHub: @Keshabkjha
LinkedIn: keshabkjha

Project Link: https://github.com/Keshabkjha/Inscribe

🧰 Tech Stack

Backend

• Node.js - JavaScript runtime
• Express - Web framework
• Socket.IO - Real-time communication
• MongoDB - NoSQL database
• Mongoose - MongoDB object modeling

Frontend

• Canvas API - Drawing graphics
• Font Awesome - Icons and UI toolkit
• Google Fonts - Free, open-source fonts

🌟 Upcoming Features

For a detailed view of our development roadmap, please check out our ROADMAP.md file.

📊 Project Stats

---

🙏 Acknowledgments

Special thanks to these amazing projects and communities:

• Socket.IO - For enabling real-time communication
• Fabric.js - For the powerful canvas library
• Shields.io - For the beautiful badges
• The entire open-source community for their invaluable contributions

---

Made with ❤️ by Keshab Kumar Jha

4. Start the development server:

   npm run dev

5. Open http://localhost:3000 in your browser.

🛠 Development

Available Scripts

• npm start - Start the production server
• npm run dev - Start the development server with hot-reload
• npm run prod - Start in production mode
• npm run lint - Run ESLint
• npm run lint:fix - Fix linting issues
• npm run format - Format code with Prettier

Environment Variables

See .env.example for all available environment variables. RATE_LIMIT_WINDOW_MS=900000 RATE_LIMIT_MAX=100

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please make sure to update tests as appropriate and follow the Code of Conduct.

📝 License

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

📧 Contact

Keshab Kumar Jha

• Email: keshabkumarjha876@gmail.com
• GitHub: @keshabkjha
• LinkedIn: keshabkjha

Project Link: https://github.com/Keshabkjha/Inscribe

🙏 Acknowledgments

Special thanks to the following projects and communities:

• Socket.IO - For enabling real-time communication
• Express - For the minimalist web framework
• MongoDB - For the powerful NoSQL database
• Fabric.js - For the amazing canvas library
• Render - For the generous hosting
• Shields.io - For the beautiful badges
• The entire open-source community for their invaluable contributions