Update README with deployment info, etc (#79)
* Deploy steps for Vercel and Cloudflare Pages * Add warning message re: beta software * Add node 17 version warning
This commit is contained in:
parent
3b5cabee11
commit
ba3a90ad4c
73
README.md
73
README.md
|
|
@ -1,11 +1,16 @@
|
||||||
# Webnative App Template
|
# Webnative App Template
|
||||||
|
|
||||||
[](https://fission.codes) [](https://github.com/fission-suite/webnative) [](https://discord.gg/zAQBDEq) [](https://talk.fission.codes) [](https://app.netlify.com/sites/webnative/deploys)
|
[](https://fission.codes) [](https://github.com/fission-suite/webnative) [](https://discord.gg/zAQBDEq) [](https://talk.fission.codes)
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
The Webnative App Template is a clone-and-go template for building a web application using Webnative, fast. Clone, customize, and deploy to have a running distributed app in mere minutes.
|
The Webnative App Template is a clone-and-go template for building a web application using Webnative, fast. Clone, customize, and deploy to have a running distributed app in mere minutes.
|
||||||
|
|
||||||
|
<div style="background-color: #FEEB80; padding: 1px 20px; border-radius: 10px;">
|
||||||
|
<p class="text-align: center;"><strong>❗️Webnative is beta software.</strong></p>
|
||||||
|
<p>We recommend you <u>do not develop production applications using the Webnative App Template</u> at this time. We're working on making it reliable, fast, and awesome, but we're not there yet!</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
## 🤔 What's Webnative?
|
## 🤔 What's Webnative?
|
||||||
|
|
||||||
[The Webnative SDK](https://github.com/fission-codes/webnative) empowers developers to build fully distributed web applications without needing a complex back-end. The SDK provides:
|
[The Webnative SDK](https://github.com/fission-codes/webnative) empowers developers to build fully distributed web applications without needing a complex back-end. The SDK provides:
|
||||||
|
|
@ -27,10 +32,10 @@ The Webnative App Template provides a _silky-smooth user experience_ out of the
|
||||||
|
|
||||||
The app template is built with modern web technologies:
|
The app template is built with modern web technologies:
|
||||||
|
|
||||||
- SvelteKit (powered by Vite under the hood)
|
- [SvelteKit](https://kit.svelte.dev/) (powered by [Vite](https://vitejs.dev/) under the hood)
|
||||||
- TypeScript
|
- [TypeScript](https://www.typescriptlang.org/)
|
||||||
- Tailwind
|
- [Tailwind](https://tailwindcss.com/)
|
||||||
- DaisyUI
|
- [DaisyUI](https://daisyui.com/)
|
||||||
|
|
||||||
### 👩🏫 A simple Webnative demo to learn from
|
### 👩🏫 A simple Webnative demo to learn from
|
||||||
|
|
||||||
|
|
@ -40,9 +45,11 @@ The app template includes a functioning application: an image gallery. Check out
|
||||||
|
|
||||||
## 🚀 Getting Started
|
## 🚀 Getting Started
|
||||||
|
|
||||||
You can try out the template yourself [here](https://webnative.netlify.app/).
|
You can try out the template yourself [here](https://webnative-template.fission.app/).
|
||||||
|
|
||||||
Ready? Let's go:
|
Ready? Let's go.
|
||||||
|
|
||||||
|
Prerequiste: ensure you are running Node 16.14 or greater, but _not_ Node 17 (18 is fine though!).
|
||||||
|
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
|
|
||||||
|
|
@ -107,21 +114,20 @@ Check out the [Webnative Guide](https://guide.fission.codes/developers/webnative
|
||||||
|
|
||||||
## 🧨 Deploy
|
## 🧨 Deploy
|
||||||
|
|
||||||
The Webnative App Template is currently deployed as a [Netlify app](https://webnative.netlify.app) and a [Fission app](https://webnative-template.fission.app), but it should be supported on any static hosting platform (Vercel, Cloudflare Pages, etc).
|
Any static hosting platform should be supported. The Webnative App Template is currently deployed on:
|
||||||
|
|
||||||
### Netlify
|
- [Fission](#fission-app-hosting)
|
||||||
|
- [Netlify](#netlify)
|
||||||
In order to deploy your Webnative application on Netlify:
|
- [Vercel](#vercel)
|
||||||
|
- [Cloudflare Pages](#cloudflare-pages)
|
||||||
1. Create a new Netlify site and connect your app's git repository. (If you don't have your application stored in a git repository, you can upload the output of a [static build](#static-build).)
|
|
||||||
2. Netlify takes care of the rest. No Netlify-specific configuration is needed.
|
|
||||||
3. There is no step 3.
|
|
||||||
|
|
||||||
### Fission App Hosting
|
### Fission App Hosting
|
||||||
|
|
||||||
|
Try out [Webnative App Tempalte on Fission](https://webnative-template.fission.app)
|
||||||
|
|
||||||
A Webnative application can be published to IPFS with the [Fission CLI](https://guide.fission.codes/developers/cli) or the [Fission GitHub publish action](https://github.com/fission-suite/publish-action).
|
A Webnative application can be published to IPFS with the [Fission CLI](https://guide.fission.codes/developers/cli) or the [Fission GitHub publish action](https://github.com/fission-suite/publish-action).
|
||||||
|
|
||||||
To publish with the Fission CLI:
|
**To publish with the Fission CLI:**
|
||||||
|
|
||||||
1. [Install the CLI](https://guide.fission.codes/developers/installation)
|
1. [Install the CLI](https://guide.fission.codes/developers/installation)
|
||||||
2. Run `fission setup` to make a Fission account
|
2. Run `fission setup` to make a Fission account
|
||||||
|
|
@ -132,7 +138,7 @@ To publish with the Fission CLI:
|
||||||
|
|
||||||
Your app will be available online at the domain assigned by the register command.
|
Your app will be available online at the domain assigned by the register command.
|
||||||
|
|
||||||
To set up the GitHub publish action:
|
**To set up the GitHub publish action:**
|
||||||
|
|
||||||
1. Register the app with the CLI
|
1. Register the app with the CLI
|
||||||
2. Export your machine key with `base64 ~/.config/fission/key/machine_id.ed25519`
|
2. Export your machine key with `base64 ~/.config/fission/key/machine_id.ed25519`
|
||||||
|
|
@ -141,6 +147,39 @@ To set up the GitHub publish action:
|
||||||
|
|
||||||
See the [Fission Guide](https://guide.fission.codes/developers/installation) and the publish action README for more details.
|
See the [Fission Guide](https://guide.fission.codes/developers/installation) and the publish action README for more details.
|
||||||
|
|
||||||
|
### Netlify
|
||||||
|
|
||||||
|
[](https://app.netlify.com/sites/webnative/deploys)
|
||||||
|
|
||||||
|
In order to deploy your Webnative application on Netlify:
|
||||||
|
|
||||||
|
1. Create a new Netlify site and connect your app's git repository. (If you don't have your application stored in a git repository, you can upload the output of a [static build](#static-build).)
|
||||||
|
2. Just click Deploy. Netlify takes care of the rest. No Netlify-specific configuration is needed.
|
||||||
|
3. There is no step 3.
|
||||||
|
|
||||||
|
### Vercel
|
||||||
|
|
||||||
|
Try out the [Webnative App Template on Vercel](https://webnative-template.vercel.app/).
|
||||||
|
|
||||||
|
In order to deploy your Webnative application on Vercel:
|
||||||
|
|
||||||
|
1. Create a new Vercel project and connect your app's git repository. (If you don't have your application stored in a git repository, you can upload the output of a [static build](#static-build).)
|
||||||
|
2. Override the default output directory and set it to `build`.
|
||||||
|
3. Deploy. That's it!
|
||||||
|
|
||||||
|
### Cloudflare Pages
|
||||||
|
|
||||||
|
Try out the [Webnative App Template on Cloudflare Pages](https://webnative-template.pages.dev/).
|
||||||
|
|
||||||
|
In order to deploy your Webnative application on Cloudflare Pages:
|
||||||
|
|
||||||
|
1. Create a new Pages project and connect your app's git repository. (If you don't have your application stored in a git repository, you can upload the output of a [static build](#static-build).)
|
||||||
|
2. Select `SvelteKit` from the "Framework preset".
|
||||||
|
3. Set the "Build output directory" to `build`.
|
||||||
|
4. Under "Environment variables", add a variable with name of `NODE_VERSION` and value of `16`.
|
||||||
|
5. Add the same environment variable to the "Preview" environment.
|
||||||
|
6. Click "Save and Deploy".
|
||||||
|
|
||||||
### Static Build
|
### Static Build
|
||||||
|
|
||||||
Export a static build.
|
Export a static build.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue