https://github.com/ianahart/jate-text-editor
An in-browser text editor that is a progressive web application
https://github.com/ianahart/jate-text-editor
javascript nodejs pwa service-workers webpack
Last synced: 3 months ago
JSON representation
An in-browser text editor that is a progressive web application
- Host: GitHub
- URL: https://github.com/ianahart/jate-text-editor
- Owner: ianahart
- License: mit
- Created: 2024-05-03T01:12:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-03T18:00:05.000Z (over 1 year ago)
- Last Synced: 2025-07-08T03:09:50.588Z (3 months ago)
- Topics: javascript, nodejs, pwa, service-workers, webpack
- Language: JavaScript
- Homepage: https://jate-text-editor-34b2.onrender.com/
- Size: 97.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jate Text Editor
## Built With
- Node.js
- Webpack
- JavaScript
## Description
Jate or just another text editor is a a progressive web application. This application uses webpack to add necessary plugins including css-loader and babel to be able to run newer css and javascript on older devices. It also utilizes asset caching with the service worker giving the ability to use the application without internet connection. For persisting data, it uses IndexedDB. The manifest plugin in the webpack along with the installation event handlers allow you to distribute this application to each user's personal devices that can be used without internet connection.
## Table of Contents
- [Jate Text Editor](#jate-text-editor)
- [Built With](#built-with)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Installation(Locally)](#installationlocally)
- [Usage](#usage)
- [Visuals](#visuals)
- [Tests](#tests)
- [Credits](#credits)
- [References](#references)
- [License](#license)
- [Future Development](#future-development)
- [Contributing](#contributing)
- [Badges](#badges)
- [Questions](#questions)
## Installation(Locally)
- Fork the repo to make a copy.
- Next, clone the project using `git clone https://github.com/ianahart/jate-text-editor.git`.
- In the root of the directory run `npm install` to install the dependencies for the client and the server.
- After the dependencies have been installed run the command `npm run start` to startup the application.
- You will be able to visit the application at `http://localhost:8080/` specifed by webpack.
## Usage
To use the application click inside the editor and start writing some JavaScript! :)
## Visuals
Visit Live application [here](https://jate-text-editor-34b2.onrender.com/)
## Tests
N/A
## Credits
Most of the boilerplate for this project was provided by edX bootcamps.
## References
- [Idb npm package](https://www.npmjs.com/package/idb)
- [Workbox](https://developer.chrome.com/docs/workbox/caching-resources-during-runtime)
## License
This project is covered under MIT License
License Text
```
Copyright (c) 2024 Ian Hart
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
## Future Development
As of now I have no plans to develop this application any further. However, this code base can be used as a starting point for future of development of a text editor.
## Contributing
No contributions are being accepted at this time.
## Badges
[](https://github.com/ianahart/jate-text-editor/blob/main/LICENSE)
[](https://github.com/ianahart/jate-text-editor/issues)
[](https://github.com/ianahart/jate-text-editor/stargazers)
## Questions
- Get in touch with me through [email](mailto:ianalexhart@gmail.com).
- Check out my GitHub [profile](https://github.com/ianahart).