Git Product home page Git Product logo

min-hinthar / text-editor-pwa-heroku Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 324 KB

I have been tasked to build a text editor that runs in the browser. The app will be a single-page application that meets the PWA criteria. Additionally, it will feature a number of data persistence techniques that serve as redundancy in case one of the options is not supported by the browser. The application will also function offline.

License: MIT License

HTML 9.98% JavaScript 63.83% CSS 26.19%

text-editor-pwa-heroku's Introduction

Project Title [ Text-Editor-PWA-Heroku ]

License Badges

Getting Started Getting Started


Table of Contents

  1. Description
  2. Installation
  3. Usage
  4. Contributing
  5. Tests
  6. License
  7. Questions

Description

I have been tasked to build a text editor that runs in the browser. The app will be a single-page application that meets the PWA criteria. Additionally, it will feature a number of data persistence techniques that serve as redundancy in case one of the options is not supported by the browser. The application will also function offline.

Tech Stacks: Single-Page Progressive Web Application Offline Functionality: Service Worker, Cache Static Assets Babel Dependency Webpack PWA Manifest Plug-in


Installation

Concurrently, Nodemon, Express


Usage

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


Contributing

YES PLEASE


Tests

npm test


License

MIT


Questions

GitHub Username: min-hinthar


text-editor-pwa-heroku's People

Contributors

min-hinthar avatar

Watchers

 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.