https://github.com/oshkoshbagoshh/pwa-jate

Just Another Text Editor.
https://github.com/oshkoshbagoshh/pwa-jate

Last synced: 19 days ago
JSON representation

Just Another Text Editor.

• Host: GitHub
• URL: https://github.com/oshkoshbagoshh/pwa-jate
• Owner: oshkoshbagoshh
• License: mit
• Created: 2023-07-19T14:53:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-20T14:34:35.000Z (over 1 year ago)
• Last Synced: 2024-10-16T19:41:22.917Z (2 months ago)
• Language: JavaScript
• Size: 2.95 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Progressive Web App - Just Another Text Editor

## Heroku Deployment 

- [Heroku Deployment](https://aj-jate-f41cfdd72912.herokuapp.com/)

## Description

- This project is a Progressive Web Application that functions as a text editor that allows users to install the application on their device and use it offline. The application also allows users to save their work to their local device.

- It includes a manifest.json file that allows the application to be installed on a device and a service-worker.js file that allows the application to function offline.

## Table of Contents (Optional)

If your README is long, add a table of contents to make it easy for users to find what they need.

- [Installation](#installation)

- [Usage](#usage)

- [Credits](#credits)

- [License](#license)

## Installation

- To install this application, the user can clone the repository from GitHub using the following command:

```sh

git clone

cd 'directory-name'

npm install

npm run start

```

- The user can also view the deployed application on Heroku using the following link:

- [Heroku Deployment](https://aj-jate-f41cfdd72912.herokuapp.com/)

  

## Usage

- The user can use this application to create and save text files on their local device. 

- The user can also install the application on their device and use it offline. When going back online, the user will see that their changes have still been saved.

  

- Screenshots of the application are included below:

  - ![gifs of the app](Assets/00-demo.gif)

  - ![gifs of the app](Assets/01-manifest.png)

  - ![gifs of the app](Assets/02-service-worker.png)

  - ![gifs of the app](Assets/03-idb-storage.png)

## Credits

- AJ Javadi

- ChatGPT for Troubleshooting

- Northwestern University Coding Bootcamp

## License

- MIT License

---

## Badges

![badmath](https://img.shields.io/github/languages/top/lernantino/badmath)

## Features

- Run offline

- Install

- Syntax Highlighting