Giter Club home page Giter Club logo

noteter's Introduction

License: MIT

noteter

Description

Noteter is a simple yet powerful text editor that runs in your browser. Designed as a Progressive Web Application (PWA), it offers offline capabilities and a native-like experience across various devices. Key features include:

  • Local Data Storage: Noteter uses an internal database to store your notes, ensuring that your data is always at hand, even without an internet connection.
  • Installable Application: Experience the convenience of a desktop application, as Noteter can be installed directly on your machine, providing quick and easy access to your notes.
  • User-Friendly Interface: A clean and intuitive interface makes note-taking and text editing a breeze, allowing you to focus on your thoughts and ideas without any distractions.

Noteter is more than just a text editor; it's a companion for capturing your creative ideas, organizing your thoughts, and jotting down important information.

๐Ÿ“‘ Table of Contents

โœจ Features

  • Text editing with syntax highlighting
  • Offline capabilities with service workers
  • PWA for a native-like app experience
  • Cloud-based data storage

๐Ÿ”ง Installation

  1. Clone the repository: git clone [https://github.com/Kirill777-web/noteter]
  2. Install dependencies: npm install
  3. Start the application: npm start

๐Ÿ–ฅ Usage

After installation, open your browser and navigate to http://localhost:3000/ to use Noteter Your changes are saved automatically and available even when offline.

๐Ÿ”— Links

๐Ÿ™ Credits

  • Node.js
  • Express.js
  • Workbox for service workers
  • Heroku for deployment

๐Ÿš€ Deployment

To deploy on Heroku:

  1. Create a Heroku account and install the Heroku CLI.
  2. Log in to Heroku through the CLI and create a new Heroku app.
  3. Link your GitHub repository to the Heroku app.
  4. Set up your MongoDB database on MongoDB Atlas and link it to your Heroku app.
  5. Deploy the app by pushing your code to the linked GitHub repository or directly through the Heroku CLI.

License

MIT License

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.

noteter's People

Contributors

kirill777-web avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.