https://github.com/djdyer/progress-edit
Progress Edit is not your average text editor. Not only can it run in the browser, but it can also be downloaded as a PWA, with a number of data persistence measures in case connectivity is lost. 🔌
https://github.com/djdyer/progress-edit
babel express indexeddb node pwa webpack
Last synced: 3 months ago
JSON representation
Progress Edit is not your average text editor. Not only can it run in the browser, but it can also be downloaded as a PWA, with a number of data persistence measures in case connectivity is lost. 🔌
- Host: GitHub
- URL: https://github.com/djdyer/progress-edit
- Owner: djdyer
- License: mit
- Created: 2022-01-10T16:31:45.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-20T17:27:14.000Z (over 4 years ago)
- Last Synced: 2025-06-25T22:02:44.910Z (12 months ago)
- Topics: babel, express, indexeddb, node, pwa, webpack
- Language: JavaScript
- Homepage: https://progress-edit.herokuapp.com/
- Size: 3.04 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# progress-edit
## Table of Contents
- [Description](#description)
- [User Story](#user-story)
- [Installation](#installation)
- [Deployment](#deployment)
- [License](#license)
- [Demo](#demo)
- [Criteria](#criteria)
## Description
Progress Edit is not only a text editor that runs in the browser, but it is also a Progressive Web App with a number of data persistence measures serving as redundancy in case one of the options is not supported by the browser, or online connectivity is lost. The app uses the `idb` package methods to get and store data to an IndexedDB database.
## User Story
```
AS A developer
I WANT to create notes or code snippets with or without an internet connection
SO THAT I can reliably retrieve them for later use
```
## Installation
⬇️
Must first initialize with the following commands:
```
npm i
npm run build
```
Application will then run in the command-line with:
```
npm run dev
```
## Deployment
[
](https://progress-edit.herokuapp.com/)
**Employing the following technology:**
[
](https://nodejs.org/en/) [
](https://www.npmjs.com/package/express) [
](https://webpack.js.org/)
[
](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) [
](https://babeljs.io/)
## License
Copyright (c) David Dyer [2022]
[
](https://choosealicense.com/licenses/isc/)
## Demo
[](https://youtu.be/XG3Ww3qS-2s)
## Criteria
✅
```
when opening app in editor, user presented with client-server folder structure.
commanding `npm run dev` from root directory starts backend and serves client.
running app from terminal will bundle js files using webpack.
webpack plugins generate html file, service worker, and manifest file.
with next-gen js applied, app still functions in browser with no error.
when opening text editor, idb immediately creates database storage.
user enters content and clicks off dom window, content is saved with idb.
reopening app after closing, will display content retrieved from idb.
clicking install button will download app as an icon on user desktop.
loaded web app will have registered service worker using workbox.
after service worker registration, user has static assets pre-cached upon loading.
deploying to heroku has proper build scripts for webpack.
```
Let's build something!
🛠️