update README
This commit is contained in:
parent
08d0c2f9be
commit
d059330584
GPG key ID:
CC4A4CB950D7E579
1 changed files with 26 additions and 35 deletions
61
README.md
61
README.md
|
|
@ -1,47 +1,38 @@
|
|||
# Svelte + Vite
|
||||
# PizzaDashboard
|
||||
|
||||
This template should help get you started developing with Svelte in Vite.
|
||||
View orders made with my demo pizza ordering phone system (not yet public)
|
||||
|
||||
## Recommended IDE Setup
|
||||
Written in Svelte+Vite with Appwrite as the backend.
|
||||
|
||||
[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
|
||||
## Get this running
|
||||
### Requirements
|
||||
You'll need an Appwrite server with the following:
|
||||
|
||||
## Need an official Svelte framework?
|
||||
One DB called `pizza_shop`, containing one tables called `orders`, with the following attributes:
|
||||
* `id` - int
|
||||
* `status` - int
|
||||
* `total` - double (aka float)
|
||||
* `order` - string
|
||||
|
||||
Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
|
||||
You'll need to create Indexes for `id`, `$id` and `status`.
|
||||
|
||||
## Technical considerations
|
||||
Permissions on the table should be:
|
||||
|
||||
**Why use this over SvelteKit?**
|
||||
* Any - Read
|
||||
* Users - Read, Update
|
||||
* `team:create` - Create, Read, Update, Delete
|
||||
|
||||
- It brings its own routing solution which might not be preferable for some users.
|
||||
- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
|
||||
Create a team called `create`. Users in this team can delete orders. In the future they might also be able to create orders.
|
||||
|
||||
This template contains as little as possible to get started with Vite + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
|
||||
I plan to put up the DB file at some point.
|
||||
|
||||
Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
|
||||
### Steps
|
||||
|
||||
**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 `checkJs` in the JS template?**
|
||||
|
||||
It is likely that most cases of changing variable types in runtime are likely to be accidental, rather than deliberate. This provides advanced typechecking out of the box. Should you like to take advantage of the dynamically-typed nature of JavaScript, it is trivial to change the configuration.
|
||||
|
||||
**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](https://github.com/rixo/svelte-hmr#svelte-hmr).
|
||||
|
||||
If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
|
||||
|
||||
```js
|
||||
// store.js
|
||||
// An extremely simple external store
|
||||
import { writable } from 'svelte/store'
|
||||
export default writable(0)
|
||||
1. Create a `.env` file in the root:
|
||||
```
|
||||
APPWRITE_ENDPOINT=...
|
||||
APPWRITE_PROJECT=...
|
||||
```
|
||||
|
||||
2. Install dependancies - `npm install`
|
||||
3. Run - `npm run dev`, or build - `npm run build`
|
||||
Loading…
Reference in a new issue