https://github.com/mleftwich/editext

PWA Text Editor
https://github.com/mleftwich/editext

Last synced: 7 days ago
JSON representation

PWA Text Editor

• Host: GitHub
• URL: https://github.com/mleftwich/editext
• Owner: mleftwich
• License: mit
• Created: 2022-09-20T02:38:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-01T05:32:58.000Z (about 2 years ago)
• Last Synced: 2024-11-06T03:48:25.534Z (about 2 months ago)
• Language: JavaScript
• Size: 84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

  ![MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=green)

  # Editxt

  

  ## Table of Contents

  * [Description](#description)

  * [Technologies](#technologies)

  * [Installation](#installation)

  * [Usage](#usage)

  * [Contributing](#contributing)

  * [Guidelines](#guidelines)

  * [Tests](#tests)

  * [License](#license)

  * [Questions](#questions)

---

  ## Description

  Editxt is a simple text editor that uses indexedDB to store and retrieve information. Compiled using node, it incorporates the use of webpacks to render the UI and service worker to allow communication between the DOM and server so the application is able to run offline and be installed to run on a local machine, similar to a native app - making it a progressive web application or 'PWA'.

  ![screenshot](./assets/images/screenshot.png)

  ## Technologies

  * React

  * JavaScript

  * node.js

  

  ## Installation

   Visit [the application](http://editxt.herokuapp.com) and click on the install button

  ## Usage

   To use the application install node packages with npm installand start with npm run start - or visit editxt.herokuapp.com

  ## Contributing

   If you'd like to contribute, reach out via the email below

  ## Guidelines

   Can be used on or offline.

  ## Tests

   Tests run in development.

  ## License

   Licensed under [MIT](https://opensource.org/licenses/MIT) 

   ---

  ## Questions

   For any questions you can find me at [GitHub](https://github.com/mleftwich) or email me at [[email protected]](mailto:[email protected])