Skip to content

Latest commit

 

History

History
64 lines (54 loc) · 1.65 KB

README.md

File metadata and controls

64 lines (54 loc) · 1.65 KB
Raw

PWA Text Editor

Description

The PWA Text Editor is a Progressive Web Application (PWA) that allows users to create and store text notes or code snippets. With or without an internet connection, users can reliably retrieve their saved content for later use. This single-page application provides a seamless user experience both online and offline.

Table of Contents

Mock up

00-demo

Technologies

  • IndexedDB
  • idb
  • Webpack
  • HTMLWebpackPlugin
  • Workbox
  • Heroku Deployment
  • Manifest.json

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/pwa-text-editor.git
cd pwa-text-editor

  2. Install dependencies:

    npm install

  3. Start the development server:

    npm run start

Usage

  1. Open your browser and navigate to http://localhost:3000.
  2. Use the text editor to create, edit, and save notes or code snippets.
  3. Content is automatically saved to IndexedDB, ensuring data persistence even when offline.

Contributing

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/your-feature-name
  3. Commit your changes: 
    git commit -m 'Add some feature'
  4. Push to the branch: 
    git push origin feature/your-feature-name
  5. Open a pull request.

License

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