https://github.com/jay1194/text-editor
The PWA Text Editor is a Progressive Web Application that enables users to create and store text notes or code snippets seamlessly, with or without an internet connection. It offers reliability and accessibility for later use, providing a convenient and efficient user experience.
https://github.com/jay1194/text-editor
babel-plugin cache-api fetch-api heroku-deployment htmlwebpackplugin idb indexeddb install javascript lighthouse-audits offline-capable plugins pwa web-manifest webpack workbox-webpack-plugin
Last synced: 11 months ago
JSON representation
The PWA Text Editor is a Progressive Web Application that enables users to create and store text notes or code snippets seamlessly, with or without an internet connection. It offers reliability and accessibility for later use, providing a convenient and efficient user experience.
- Host: GitHub
- URL: https://github.com/jay1194/text-editor
- Owner: Jay1194
- License: mit
- Created: 2024-06-04T18:28:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-06T00:34:16.000Z (over 1 year ago)
- Last Synced: 2024-06-06T19:46:22.502Z (over 1 year ago)
- Topics: babel-plugin, cache-api, fetch-api, heroku-deployment, htmlwebpackplugin, idb, indexeddb, install, javascript, lighthouse-audits, offline-capable, plugins, pwa, web-manifest, webpack, workbox-webpack-plugin
- Language: JavaScript
- Homepage: https://aqueous-island-60408-9a0ce4ae30e6.herokuapp.com/
- Size: 203 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
- [Technologies](#technologies)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Mock up
## Technologies
- IndexedDB
- idb
- Webpack
- HTMLWebpackPlugin
- Workbox
- Heroku Deployment
- Manifest.json
## Installation
1. Clone the repository:
```bash
git clone https://github.com/your-username/pwa-text-editor.git
cd pwa-text-editor
```
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
```bash
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:
```bash
git checkout -b feature/your-feature-name
```
3. Commit your changes:
```bash
git commit -m 'Add some feature'
```
4. Push to the branch:
```bash
git push origin feature/your-feature-name
```
5. Open a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.