This is a single-page text editor that runs in a browser and meets the PWA criteria. It features a number of data persistence techniques that serve as redundancy in case one of the options is not supported by the browser. The application is deployed on Heroku and also functions offline. It has the following interface:
A deployed version can be viewed here.
See the application's GitHub repository here.
Clone my repository on GitHub.
To install the application's dependencies and devDependencies, run:
npm install
To invoke the application, run:
npm run start
Please see the video and screenshots.
This application is developed to allow users to create notes or code snippets with or without an internet connection, so users can reliably retrieve them for later use. It follows the features and functionalities required in the Assignment's README:
-
When the user opens the application in the user's editor, the user will see a client server folder structure.
-
When the user runs
npm run startfrom the root directory, the application starts up the backend and serve the client. -
When the user runs the text editor application from my terminal, the user will find that the application's JavaScript files have been bundled using webpack.
-
When the user runs the webpack plugins, the user will find a generated HTML file, service worker, and a manifest file.
-
When the user uses next-gen JavaScript in the application, the text editor still functions in the browser without errors.
-
When the user opens the text editor, the user will find the IndexedDB has immediately created a database storage.
-
When the user enters content and subsequently clicks off of the DOM window, the content in the text editor is saved with IndexedDB.
-
When the user reopens the text editor after closing it, the content in the text editor has been retrieved from the IndexedDB.
-
When the user clicks on the Install button, the application is downloaded as an icon on the user's desktop.
-
When the user loads the application, the user can register a service worker using workbox.
-
When the user registers a service worker, the user's static assets are pre cached upon loading along with subsequent pages and static assets.
-
When the user deploys to Heroku, the user has a proper build scripts for a webpack application.
License used for this project - MIT
For more information on the above license and other license types, please see the following websites:
To contribute to this application: Please email the author for guidelines.
During development, the application is tested using localhost.
The following people/resources were consulted and/or utilized in the development of this application:
- Unit 19 PWA reading materials, videos, and internet resources.
- Coding Bootcamp Heroku Deployment Guide
- Troubleshooting Node.js Deploys
- Stackoverflow for troubleshooting Heroku deployment
Jane Tiglao
For questions or issues, please contact:
- Jane Tiglao
- Email: janeytiglao@gmail.com
- GitHub Username: jbtiglao
- GitHub Profile: https://github.com/jbtiglao