Giter VIP home page Giter VIP logo

nasingfaund / text-editor-3 Goto Github PK

View Code? Open in Web Editor NEW

This project forked from awidener3/text-editor

0.0 0.0 0.0 371 KB

A text editor that functions on a single page, follows PWA criteria, and works offline. The application is also able to be downloaded onto your computer or mobile device to be used outside of the browser.

Home Page: https://awidener3-jate.herokuapp.com/

JavaScript 61.85% CSS 27.63% HTML 10.52%

text-editor-3's Introduction

๐Ÿ“ Homework #11: Text Editor (J.A.T.E.)

๐Ÿ“Œ Link to Deployed Application

๐Ÿ”จ Task

Create a text/code editor that functions on a single page, follows PWA criteria, and works offline. The application will also able to be downloaded onto your computer or mobile device to be used outside of the browser.

๐Ÿงฉ Tech Stack

๐Ÿ“Ž How to Use

Visit the deployed application where you will be presented with a code/text editor. Any code or text you add will save automatically whenever you click off of the window. On refresh or revisit, the text is persistent and saved in IndexedDB.

App in-browser

Using devtools, you can see both the Service Worker active, along with a loaded Manifest.

Service worker online

App manifest detected

As you add and remove information, it is saved locally in IndexedDB

Object stored in IndexedDB

The app also works offline, thanks to the manifest and service worker

Using the app offline

The app is able to be installed as a PWA onto your device (mobile or desktop) by pressing the install button on the top left, or the in-browser install button in the URL bar.

App downloaded locally

๐Ÿ“ท Screenshots

The following screenshots follow the path of the preview video above, so you can take a closer look at the routes.

App in-browser J.A.T.E. in browser

App downloaded locally

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

Acceptance Criteria

GIVEN a text editor web application
WHEN I open my application in my editor
THEN I should see a client server folder structure
WHEN I run `npm run start` from the root directory
THEN I find that my application should start up the backend and serve the client
WHEN I run the text editor application from my terminal
THEN I find that my JavaScript files have been bundled using webpack
WHEN I run my webpack plugins
THEN I find that I have a generated HTML file, service worker, and a manifest file
WHEN I use next-gen JavaScript in my application
THEN I find that the text editor still functions in the browser without errors
WHEN I open the text editor
THEN I find that IndexedDB has immediately created a database storage
WHEN I enter content and subsequently click off of the DOM window
THEN I find that the content in the text editor has been saved with IndexedDB
WHEN I reopen the text editor after closing it
THEN I find that the content in the text editor has been retrieved from our IndexedDB
WHEN I click on the Install button
THEN I download my web application as an icon on my desktop
WHEN I load my web application
THEN I should have a registered service worker using workbox
WHEN I register a service worker
THEN I should have my static assets pre cached upon loading along with subsequent pages and static assets
WHEN I deploy to Heroku
THEN I should have proper build scripts for a webpack application

text-editor-3's People

Contributors

awidener3 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.