Skip to content

This app is a text editor that runs in the browser. It is a single-page application that 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. It will also be able to function offline.

Notifications You must be signed in to change notification settings

kristinehkim/text-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Text Editor

This app is a text editor that runs in the browser. It is a single-page application that 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. It will also be able to function offline. Live demo here.

Table of Contents

General Information

By entering npm run start:dev from the root directory, this application starts up the backend and serves the client. The text editor application will be run from the terminal and the JavaScript files will be bundled using webpack. Webpack plugins will generate HTML file, service worker, and a manifest file. While using next-gen JavaScript in the application, the text editor still functions in the browser correctly without any errors because of Babel. The text editor can be opened up in the browser and the user can enter content, click off the DOM window or close it, and reopen it to find that the content has been saved and retrieved with IndexedDB. The user can click on the icon of a square with an arrow pointing to the right corner which is to the right of the URL window to open the application or click install to download it. Once the web application is loaded, the registered service worker using workbox will have static assets pre cached upon loading along with subsequent pages and static assets which allows for it to work offline.

Technologies Used

  • Babel
  • Webpack
  • idb
  • Express
  • Nodemon
  • Concurrently

Features

  • Click on the icon of a square with an arrow pointing to the right corner which is to the right of the URL window to open the application or click install to download it.
  • Content will be saved even after closing and reopening it.
  • Application functions offline.

Screenshots

Example screenshot Example screenshot Example screenshot

Setup

In order to set up this app, enter npm i from the package.json in the root, server, and the client to download dependencies and devDependencies. Then, npm run start:dev to concurrently run the server and client. Go to http://localhost:3000/ preferrably using an Incognito window or click on the Heroku link above.

Project Status

Project is: in progress.

Acknowledgements

  • Many thanks to my instructor, Michael Pacheco, the TAs, Nirav and Julius, tutor Anastasia Warren, and all the AskBCS learning assistants.

Contact

Created by Kristine Kim. Feel free to contact me at kristinehkim@gmail.com!

About

This app is a text editor that runs in the browser. It is a single-page application that 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. It will also be able to function offline.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published