Table of Contents
This is how you can setup this project locally. To get a local copy up and running follow these steps.
Below is how to install and set up the app.
- Clone the repo
git clone https://github.com/Muhammed-Rahif/Notpad.git
- Get inside:
cd Notpad - Install npm packages
npm install
- Svelte:
npm run dev
npm run build
npm run preview- Semantic Release
- Desktop Support
- Multi-language Support
- Chinese
- Spanish
- Malayalam
See the open issues for a full list of proposed features (and known issues).
Refer CONTRIBUTING.md.
Distributed under the MIT License. See LICENSE for more information.
Muhammed Rahif - @Muhammed_Rahif - rahifpalliyalil@gmail.com
Resources that are helpful and would like to give credit to.
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);
