Skip to content
/ noter Public

PWA that allows you to create notes or code snippets with or without an internet connection.

License

Notifications You must be signed in to change notification settings

larigens/noter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Noter

logo

Text Editor
Progressive Web Application (PWA)

Noter Official Site


Node.js Express Webpack


Description

Noter is a user-friendly and reliable text editor designed for coders. With Noter, you can easily create and manage your notes and code snippets with or without an internet connection. Whether you need to quickly jot down an idea, write a complex code snippet, or organize your thoughts and projects, Noter provides you with a seamless and intuitive experience.

Table of Contents

Installation

Cloning the Repository

Click <> code - the green button. After clicking, in the local tab, copy the SSH key. Open the terminal in your Macbook or git bash, if you have Windows/Linux, and type:

git clone [paste ssh key]

Setting Up

Open the project in VS Code and make sure you are in the directory of this application before installing the dependencies. To install it, type the commands below on your terminal:

npm i

Once you run this, npm will begin the installation process of all of the current project's dependencies.

Mock-Up

The following animation demonstrates the application functionality:

noter

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

manifest.json file

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

Registered service worker

The following image shows the application's IndexedDB storage:

ndexedDB storage

Usage

Launch the application by entering the command below on your terminal:

npm run start

Afterward, a similar output should appear in your terminal:

Terminal code

After bundling the files, a newly created folder named dist should be visible to you.

dist folder

At this point, the Service Worker ought to be registered within the scope, enabling access to Noter through the following URL: http://localhost:3001/.

However, if you happen to access the application via its official website, you can effortlessly proceed to the enjoyable part and create any content you desire, without the need for an internet connection.

Furthermore, Noter offers the option to install the application on your device. To proceed with the installation, click on the "install" button located in the upper left-hand corner of the screen, and immerse yourself in the experience!

Questions

For questions and support feel free to contact me via:

📧 Email

🐈‍⬛ GitHub

Contributing

Contributing Guidelines

Want to report a bug, contribute some code, request a new feature, or improve the documentation? You can submit an issue and I will gladly welcome you as a contributor, but before submitting an issue, please search the issue tracker, as it may already exist!

Code of Conduct

Our Code of Conduct follows the same principles as the Contributor Covenant, version 2.1.

Credits

Acknowledgements

Links

Linkedin Twitter

License

Please refer to the LICENSE in the repo.