Skip to content

Latest commit

 

History

History
102 lines (59 loc) · 3.91 KB

README.md

File metadata and controls

102 lines (59 loc) · 3.91 KB

Text Editor

Description

This project is a text editing Progressive Web Application (PWA) modified to store and retrieve data, as well as offline capabilities. This has been achieved by using the IndexedDB API, idb npm wrapper for the IndexedDB API, Webpack as a module bundler, and a service worker using Workbox.

Deployed Link

This application is deployed through Heroku.

https://akc-text-editor.herokuapp.com/

Table of Contents

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 and Usage

In order to run this application, you will want to git clone this repository so that the code is on your local machine. Run npm i while in the root directory in order to install all necessary Node.js dependencies. Then run npm start to launch the server.

This application is hosted at Port 3000, so typing: http://localhost:3000/ in to the address bar of your browser while the server is running should display the user interface.

Hitting the "Install!" button allows you to save changes to the text editor regardless of whether you are online or offline. You are able to make changes, exit the application, and come back to your saved work.

Technologies Utilized

Javascript

Node.js

Express.js

IndexedDB

Workbox

Webpack

Babel

Heroku

Screenshots

Screenshot-LocalHost Application running in http://localhost:3000/


Screenshot-Heroku Application deployed to Heroku


Screenshot-Install Application installed on my local machine


This application allows me to not only edit text, exit the application, and return to find my changes preserved, BUT ALSO it is able to preserve my changes regardless of whether I am online or offline.

Contributors

Thank you for checking out my project! If you would like to see more of my work, please take a peek at my GitHub and portfolio.

Linkedin LinkedIn   GitHub GitHub

License

This project is licensed under the MIT License       License: MIT

Please click on the green MIT License Shield above to learn more about what the limitations of this license are.