https://github.com/zbichsel/pwa-text-editor

A text editor which runs in the browser
https://github.com/zbichsel/pwa-text-editor

Last synced: 14 days ago
JSON representation

A text editor which runs in the browser

• Host: GitHub
• URL: https://github.com/zbichsel/pwa-text-editor
• Owner: zbichsel
• License: mit
• Created: 2023-08-26T20:00:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-27T19:12:26.000Z (over 1 year ago)
• Last Synced: 2024-11-19T15:58:15.639Z (3 months ago)
• Language: JavaScript
• Size: 432 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pwa-text-editor

A text editor that runs in the browser online and offline.

[![JS](https://img.shields.io/badge/javascript-yellow?logo=javascript)](https://shields.io/docs/logos)

[![PWA](https://img.shields.io/badge/pwa-red?logo=pwa)](https://shields.io/docs/logos)

[![Node.js](https://img.shields.io/badge/node.js-green?logo=node.js)](https://shields.io/docs/logos)

[![Express](https://img.shields.io/badge/express-red?logo=express)](https://shields.io/docs/logos)

  ## Description

Progressive Web Apps (PWAs) are web applications that offer an enhanced user experience by combining the best of websites and mobile apps. They provide fast loading, offline accessibility, and push notifications, delivering a seamless experience across devices. PWAs can be added to the home screen and accessed without installation. This approach to web development improves user engagement.

  ## Table of Contents

  - [Installation](#installation)

  - [Usage](#usage)

  - [License](#license)

  - [Questions](#questions)

  ## Installation

Git clone the repository.

Please make sure that the **dependencies** have been installed. If not, please run the following commands:

Follow the `script` commands found in the outter `package.json`

This will install the necessary packages and versions which are necessary for the application to run. Learn more about [Concurrently](https://www.npmjs.com/package/concurrently), [Dotenv](https://www.npmjs.com/package/dotenv), [Express](https://www.npmjs.com/package/express), and [If-env](https://www.npmjs.com/package/if-env) in the links provided.

You may also access the [Heroku](https://www.heroku.com) app here directly at: [Text Editor](https://pwa-text-editor-zb-ea64fa96e8ad.herokuapp.com/).

  ## Usage

To access this PWA Text Editor application, please run the following command in your integrated terminal for this repository:

`npm run start`

  ## Screenshot

  ![Screenshot](./images/Screenshot%202023-08-27%20at%202.08.09%20PM.png)

  ![Screenshot](./images/Screenshot%202023-08-27%20at%202.10.05%20PM.png)

  ## License

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

This project is licensed under MIT. Please check LICENSE document in repository for more information.

  ## How to Contribute

If you would like to contribute to this project, please open a new issue or submit a pull request.

  ## Tests

Testing of this application requires the installation and use of Insomnia at this time.

  ## Questions

  If you have any questions, feel free to reach me at [GitHub](https://github.com/zbichsel) or via email at [[email protected]]([email protected]).