From e593da839865ddfa511730b53a60c90ab64e5f57 Mon Sep 17 00:00:00 2001 From: Daniel Bulant Date: Tue, 19 Apr 2022 22:04:05 +0200 Subject: [PATCH] add readme --- README.md | 67 ++++--------------------------------------------------- 1 file changed, 4 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index e206c24..9cdf99a 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,8 @@ -# routify-starter +# Mangades -Starter template for [Routify](https://github.com/roxiness/routify). +Mangadex viewer and downloader. Uses svelte+routify. -### Get started - -#### Starter templates -| Template | Description | -|-------------------------------------------|-------------------------------------------------------------| -| [master](https://example.routify.dev/) | Default template, includes examples folder | -| [blog](https://blog-example.routify.dev/) | Generates a blog from local markdown posts. Includes mdsvex | -| [auth](https://auth-example.routify.dev/) | Embedded login on protected pages. Includes Auth0 | - -To use a template, run: - -`npx @roxi/routify init` - -or - -`npx @roxi/routify init --branch ` - -The above commands will populate the current directory, they don't create a new one. - -### npm scripts - -| Syntax | Description | -|------------------|-----------------------------------------------------------------------------------| -| `dev` | Development (port 5000) | -| `dev:nollup` | Development with crazy fast rebuilds (port 5000) | -| `dev-dynamic` | Development with dynamic imports | -| `build` | Build a bundled app with SSR + prerendering and dynamic imports | -| `serve` | Run after a build to preview. Serves SPA on 5000 and SSR on 5005 | -| `deploy:*` | Deploy to netlify or now | -| `export` | Create static pages from content in dist folder (used by `npm run build`) | - -### SSR and pre-rendering - -SSR and pre-rendering are included in the default build process. - -`npm run deploy:(now|netlify)` will deploy the app with SSR and prerendering included. - -To render async data, call the `$ready()` helper whenever your data is ready. - -If $ready() is present, rendering will be delayed till the function has been called. - -Otherwise it will be rendered instantly. - -See [src/pages/example/api/[showId].svelte](https://github.com/roxiness/routify-starter/blob/master/src/pages/example/api/%5BshowId%5D.svelte) for an example. - -### Production - -* For SPA or SSR apps please make sure that url rewrite is enabled on the server. -* For SPA redirect to `__app.html`. -* For SSR redirect to the lambda function or express server. - -### Typescript - -For Typescript, we recommend [@lamualfa](https://github.com/lamualfa) excellent [routify-ts](https://github.com/lamualfa/routify-ts/) - -New project: `npx routify-ts init [routify-init-args]` - -Existing project: `npx routify-ts convert [project-directory]` +Minimalistic. -### Issues? - -File on Github! See https://github.com/sveltech/routify/issues . +See it live [here at manga.danbulant.eu](https://manga.danbulant.eu). \ No newline at end of file