Online Sharable eNotepad

Online Notepad is an open-source project that provides a web-based notepad application built using ASP.NET and integrated with Azure Table Storage. The goal of this project is to create a simple yet efficient online notepad tool that allows users to share notes and files among multiple viewer.

Table of Contents

• Overview & Description
  • Features
  • Benefits
• Usage
• Demo
• Getting Started
  • Prerequisites
  • Tech Stack
  • Installation
  • Deployment
    • Azure Table Storage
• Authors and Acknowledgment
  • Contributors
• Contributing
• Versioning & Change log
  • V1.1
  • V1.0
• License
• Contact
• Project Status

Overview & Description

An online sharable notepad is a digital platform that allows users to create, edit, and manage notes in real-time. It’s designed for simplicity and ease of use, enabling individuals to jot down ideas, tasks, or any information quickly.

Features

An online sharable notepad is a versatile tool that can enhance productivity and organization, whether for personal use or collaborative projects. It’s particularly useful for those who prefer digital over traditional note-taking methods.

• Accessibility: Accessible from any device with an internet connection.
• Real-Time Collaboration: Multiple users can work on the same document simultaneously.
• File Sharing: Multiple file can able to share along with the note.
• Auto-Save: Notes are saved automatically, reducing the risk of data loss.
• Cloud-Based: Notes are stored in the cloud, ensuring they are backed up and retrievable from anywhere.
• Security: Some platforms offer password protection to keep notes private.
• Shareability: Notes can be shared with others via a unique URL.
• Customizability: Notes URL can be customize.

Benefits

Using this online sharable notepad has some benefits.

• Convenience: Eliminates the need for physical paper and is available across all your devices.
• Organization: Features like tagging and categorization help keep notes organized.
• Searchability: Easy to search through a large collection of notes.

Usage

Provide examples or instructions on how to use the project. This could include code snippets, command-line examples, or screenshots.

Demo

• URL - https://e-notepad-dotnet48.azurewebsites.net/
• User Email: demo@demo.in
• Password: demo

This OTP authentication is only demo purpose. ✨

Getting Started

How to setup, build and deploy this application, you have to read source/README.md

Authors and Acknowledgment

• Soubhik Nandy - Initial work - @JicoDotNet - Code Owner
• See also the list of contributors who participated in this project.

Contributors

• Debasish Sahoo - Architecture @debasishsahoo
• Tuhin Paul - Code Review - @codewithtuhin

Contributing

This project is a collaborative effort that can involve various forms of participation. Here’s a guide on how you can contribute:

Submitting Bug Reports

• Identify the Bug: Clearly describe the issue you’ve encountered. Include details such as the context in which the bug occurred, steps to reproduce it, and the expected vs. actual results.
• Check Existing Issues: Before submitting a new bug report, search the project’s issues to ensure it hasn’t been reported already.
• Use the Template: Follow any issue template provided by the project. This often includes specific details the maintainers need.
• Include Logs and Screenshots: If applicable, add logs and screenshots to help maintainers understand the problem.

Feature Requests

• Suggesting Enhancements: Propose new features or improvements to existing ones. Explain the benefits and potential impact on the project.
• Discuss in Issues: Use the project’s issues section to discuss ideas with maintainers and other contributors.
• Be Patient: Remember that maintainers are often volunteers. It may take time for them to respond to your request.

Pull Requests

• Fork the Repository: Create your own copy of the project to work on.
• Create a Branch: Make a new branch in your fork for your changes.
• Make Changes: Implement your bug fix or feature, adhering to the project's coding standards.
• Write Tests: If the project has tests, add tests for your changes to ensure they work as expected.
• Pull Request: Submit a pull request to the original repository. Fill in the provided PR template with details of your changes.
• Code Review: Be open to feedback and make requested changes during the code review process.

Remember to always read the project’s CONTRIBUTING.md file, as it will contain specific guidelines tailored to the project’s needs. You are open to contributing. Happy contributing! 🚀

Versioning & Change log

We use SemVer for versioning. For the versions available, see the tags on this repository.

V1.1

New/Changed/Removed features

Customize URI manage and some bug fix. .Net Framework version upgrade.

Features

• Customize Note code (uri)
• .NET Framework version upgrade to implement Github CI

Maintenance/Miscellaneous

• Bug fix in logic level
• Bug fix in UI level
• add MIME type

V1.0

New/Changed/Removed features

Initial implementation of this app

Features

• Login Page
• Note edit page
• Notes record page
• Note display page
• File sharing with a note

Maintenance/Miscellaneous

N/A

License

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

• MIT License Details

Contact

Anyone can contact us regarding this project.

Email: github.connect@soubhiknandy.com

Project Status

The project is currently in the alpha stage; active development is in progress.

This project was built and developed in 2021. In January 2024 it is migrated from Azure DevOps to Github.