Skip to content

djdyer/progress-edit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

16 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

progress-edit

Table of Contents



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


Employing the following technology:




License

Copyright (c) David Dyer [2022]



Demo




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!

๐Ÿ› ๏ธ

About

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. ๐Ÿ”Œ

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors