Week-19 Challenge (Progressive Web Applications)
This application was specifically developed to showcase and enhance skills in progressive web application development. Its main goal was to gain a deeper understanding of the inner workings of the React JavaScript library. The application focuses on four key areas:
-
Configuration: Setting up the webpack.config.js file with essential workbox plugins for service worker and manifest files, along with CSS and babel loader for compatibility with older code. -
Offline functionality: Implementing asset caching in the src-sw.js file to enable the application to work offline. -
Database integration: Configuring the database to facilitate data management, including addition, updating, and retrieval from the IndexedDB. -
User-friendly installation: Adding event handlers to the install button for easy installation on personal application stacks and offline usage.
https://berkeley-text-editor-8193bd508667.herokuapp.com/
This application is powered by Webpack (HTML-Webpack-Plugin, Babel, and CSS Loader), Node.js (v16.19.1), Express.js (v.14.17.1), and JavaScript. Nodemon (v2.0.4) and Concurrently (v5.2.0) were utilized as a devDependencies allowing the server to refresh when edits were made to application, and allowing both the front end and back end to be ran on a single command (npm run start:dev).
Users can view and utilize the application through the use of the browser by visiting the deployed application at https://jate-text-editor15-e077c2d0ee63.herokuapp.com/.
Viewing the application in the browser will also give users the ability to download the application allowing it to be used offline.
To make any further additions, start by cloning the repo in the command line git clone https://github.com/rmessett15/PWA-Text-Editor.git, or forking the repo.
Once the application is opened, the IndexedDB will persist any notes added to the site. There is no need to save any information as the application automatically updates the IndexedDB -> The only thing required for this feature to occur is that the user clicks out of the window. When returning to the site, they will find all of their notes and other information persisted to the page.
Usage of this application is very intuitive, just visit the live URL (https://jate-text-editor15-e077c2d0ee63.herokuapp.com/) and start adding notes right away! Users will also notice an install button in the nav bar allowing for the application to be downloaded and used offline. Saving of notes occurs automatically through the IndexedDB; the only thing required is for the user to click out of the window and notes will be persisted whether using the application online or offline.
Open to collaboration, if you choose to do so open an issue and modify any changes you would like to see on a feature branch and wait for approval before merging to the main branch.
NOTICE: Contributor Covenant is released under the Creative Commons Attribution 4.0 International Public License, which requires that attribution be included.
There is currently no unit testing written yet for this application.
NOTICE: This application is covered under the MIT License
Need more information? You can contact me through my LinkedIn or Email. Links provided below.
Click for LinkedIn -> LinkedIn
Click to Email -> Email