Dreamcatcher Text Editor 🌙

Description 📝

Dreamcatcher Text Editor was created as a simple text editor app that can function both online and offline, with a variety of data persistence options in order to ensure that data is not lost in any scenario. This application implement methods for getting and storing data to an IndexedDB database. It also use the idb package, which is a lightweight wrapper around the IndexedDB API. For use offline, this application can be downloaded to your desktop as an application. It features a number of methods that are useful for storing and retrieving data, and is used by companies like Google and Mozilla.

Link to the deployed app on Heroku : https://dreamcatcher-texteditor.herokuapp.com/

Table of Contents 📖

• Application Preview ⭐
• Installation 🗳
• Usage 💡
• Technologies 🔧
• Contribution 👩🏻‍💻
• Questions ❓
• Credits 🙌

Application Preview ⭐

GIF demonstrates the application functionality

Customized logo

Customized header

const header = `
/*                                                  
__  ___ ___  __  __ __  ___ __ _____ ____  _ ___ ___  
| _\| _ \ __|/  \|  V  |/ _//  \_   _/ _/ || | __| _ \ 
| v | v / _|| /\ | \_/ | \_| /\ || || \_| >< | _|| v / 
|__/|_|_\___|_||_|_| |_|\__/_||_||_| \__/_||_|___|_|_\ 
                                                       
Dreamcatcher Text Editor
*/                          
`;

Console shows the application retrieves database, injecting to editor, and successfully saving to DB.

The following image shows the application's manifest.json file:

The following image shows the application's registered service worker:

The following image shows the application's IndexedDB storage:

Installation 🗳

• Open Heroku deployed application : https://dreamcatcher-texteditor.herokuapp.com/
• Go to the link and hit the "install" button to install the app locally.

For repo clone or download:

• Download or clone repository to use this application on local machine.
• Node.js is required to run the application
• To install necessary dependencies, run the following command :

npm i

• Run npm run start:dev and npm run start in terminal to start.
• Then go to http://localhost:3000/ to run this application on your local machine.

Usage 💡

Use Heroku deployed link: https://dreamcatcher-texteditor.herokuapp.com/ and install if you want to use it offline.

Technologies 🔧

• HTML
• CSS
• JavaScript
• express.js
• Node.js
• idb
• webpack
• workbox

License 📜

MIT License

Copyright (c) 2022 Sienna Li

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.

Contribution 👩🏻‍💻

If you would like to contribute to this project reach out to me. Contact Information can be found below or by clicking on the Questions link provided in the Table of Contents.

Questions ❓

📩 If you have any question, email me here at : lihexuan1@gmail.com
My Github page is siennameow

Credits 🙌

Thanks to the following people who helped me in this project:

• Jerome Chenette
• Manuel Nunes
• Vince Lee