https://github.com/cyphernyx/offline-code-editor
Progressive Web App (PWA) that functions seamlessly both online and offline. With this application, developers can create and store notes or code snippets and retrieve them whenever needed, even without an internet connection.
https://github.com/cyphernyx/offline-code-editor
expressjs indexeddb javascript nodejs progressive-web-app serviceworker webpack workbox
Last synced: 3 months ago
JSON representation
Progressive Web App (PWA) that functions seamlessly both online and offline. With this application, developers can create and store notes or code snippets and retrieve them whenever needed, even without an internet connection.
- Host: GitHub
- URL: https://github.com/cyphernyx/offline-code-editor
- Owner: CypherNyx
- License: mit
- Created: 2023-08-29T00:43:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-29T21:46:05.000Z (almost 2 years ago)
- Last Synced: 2025-01-16T22:32:09.430Z (5 months ago)
- Topics: expressjs, indexeddb, javascript, nodejs, progressive-web-app, serviceworker, webpack, workbox
- Language: JavaScript
- Homepage:
- Size: 189 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Offline Code Editor
> Module 19 - Progressive Web Applications (PWA) Challenge: Text Editor
[](https://opensource.org/licenses/MIT)
## Table of Contents
* [Description](#description)
* [Features](#features)
* [Installation](#installation)
* [Technologies](#technologies)
* [Contributing](#contributing)
* [License](#license)
* [Questions](#questions)
## Description
This is a web-based text editor designed as a one-page application, accessible directly from your browser. The application meets Progressive Web App (PWA) criteria and incorporates a range of data persistence methods. These techniques provide backup solutions in case a particular option isn't compatible with the browser. Moreover, the application can be installed and is functional while offline, allowing usability regardless of your internet connection.
### [>> View the live Application here ➡️](https://offline-code-editor-6a12c9d49a7b.herokuapp.com/)
### Please remember to use Incognito mode!
To ensure accurate testing of the offline features for this application, kindly consider using Google Chrome's incognito mode or alternatevely open a new "guest session" in your browser. This will help prevent any interference from cookies, cache, or browser history that might affect the app's performance.
## Features
- Create and edit notes or code snippets with a user-friendly text editor.
- Switch between online and offline modes and the text editor still functions in the browser without errors.
- Static assets, including HTML, service workers, and manifest files, using webpack.
- Click "Install: button to download the web application onto the desktop.
- Utilize IndexedDB for immediate database storage upon opening the text editor.
## Installation
Clone the repository:
```sh
git clone https://github.com/CypherNyx/offline-code-editor.git
```
Install the required dependencies:
```sh
npm install
```
Run the project in your local browser:
```sh
npm start
```
## Technologies
[](https://www.javascript.com/)
[](https://nodejs.org/)
[](https://expressjs.com/)
## Contributing
Pull requests are welcome. Please open an issue first to discuss any proposed changes or additions.
## License
[](https://opensource.org/licenses/MIT)
https://opensource.org/licenses/MIT
This project is open source and available under the MIT License.
## Questions
GitHub [Dahlia Guido](https://github.com/CypherNyx)
Email: [email protected]