Notpad

Table of Contents

1. Screenshot
2. Built With
3. Getting Started
   • Prerequisites
   • Installation
   • Running the Project
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments
9. Star History
10. FAQ

Screenshot

Built With

(back to top)

Getting Started

This is how you can setup this project locally. To get a local copy up and running follow these steps.

Prerequisites

• Node.js
• Pnpm

Installation

Below is how to install and set up the app.

1. Clone the repo

   git clone https://github.com/Muhammed-Rahif/Notpad.git
   

2. Get inside:

   cd Notpad
   

3. Install packages

   pnpm install
   

Running the project

Development:

• Svelte:

  pnpm run dev
  

Preview:

pnpm run build
pnpm run preview

(back to top)

Roadmap

• Semantic Release
• Desktop Support
• Multi-language Support
  • Chinese
  • Spanish
  • Malayalam

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Refer CONTRIBUTING.md.

Top contributors:

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Muhammed Rahif - @Muhammed_Rahif - rahifpalliyalil@gmail.com

(back to top)

Acknowledgments

Resources that are helpful and would like to give credit to.

• Localforage
• What you need to know about persistent state in Tauri apps

(back to top)

Star History

(back to top)

FAQ

Why global.d.ts instead of compilerOptions.types inside jsconfig.json or tsconfig.json?

Setting compilerOptions.types shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding svelte and vite/client type information.

Why include .vscode/extensions.json?

Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.

Why enable allowJs in the TS template?

While allowJs: false would indeed prevent the use of .js files in the project, it does not prevent the use of JavaScript syntax in .svelte files. In addition, it would force checkJs: false, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.

Why is HMR not preserving my local component state?

HMR state preservation comes with a number of gotchas! It has been disabled by default in both svelte-hmr and @sveltejs/vite-plugin-svelte due to its often surprising behavior. You can read the details here.

If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.

// store.ts
// An extremely simple external store
import { writable } from 'svelte/store';
export default writable(0);

(back to top)