-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This reverts commit 4ea631a.
- Loading branch information
Showing
11 changed files
with
122 additions
and
167 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,34 @@ | ||
| --- | ||
| title: What is this deep dive demo? | ||
| layout: docs | ||
| nav: demo | ||
| title: Aim | ||
| layout: framework_docs_overview | ||
| order: 2 | ||
| --- | ||
|
|
||
| To get the deep dive demo up and running on Fly.io, all you need is an empty directory and either Node or Ruby installed. But here are some more details about what the deep dive demo app actually is. | ||
| For this demo, we will start with [MDN's Web Dictaphone](https://github.com/mdn/dom-examples/tree/main/media/web-dictaphone#web-dictaphone). | ||
| You can play with a [live demo](https://mdn.github.io/dom-examples/media/web-dictaphone/). This is about as basic of an | ||
| HTML form as you can get, and it has the added bonus of providing the ability to generate as many media files as you want using only your voice. | ||
|
|
||
| The important thing to note is that this is all very straightforward stuff using industry standard components that you can run on your laptop, a VPS, AWS EC2, Google Compute Engine, or Azure. | ||
|
|
||
| The deep dive demo is based on [MDN's Web Dictaphone](https://github.com/mdn/dom-examples/tree/main/media/web-dictaphone+external). | ||
| You can play with a [live demo hosted on GitHub](https://mdn.github.io/dom-examples/media/web-dictaphone/+external). The Web Dictaphone app is about as basic of an HTML form as you can get, and it has the added bonus of providing the ability to generate as many media files as you want using only your voice. | ||
|
|
||
| Your own app might have many forms, and more complex forms, but the dictaphone app demonstrates the the basic flow. | ||
|
|
||
| The basic Web Dictaphone is client side only, requiring a web server that can deploy static assets (HTML, CSS, JS, images), like NGINX, Apache HTTPd, or Caddy. Storing the data in databases requires a server that can handle HTTP GET, POST, PUT, and DELETE requests. | ||
|
|
||
| Our deep dive demo comes in two flavors: | ||
|
|
||
| - Node.js | ||
| - Rails | ||
|
|
||
| The demo uses the following database and storage: | ||
| Your app undoubtely has many forms, and more complex forms, but once you can see the basic flow, the rest should be easy. | ||
|
|
||
| * A [PostgreSQL](https://www.postgresql.org/+external) relational database to store the names of the audio clips | ||
| * A [Tigris bucket](https://www.tigrisdata.com/+external) to store the the audio files | ||
| That demo as it currently stands is client side only, so to deploy it all you need is a web server that can deploy static assets (HTML, CSS, JS, images), | ||
| like NGINX, Apache HTTPd, or Caddy. In order to store the data in databases, we are going to need a server that can handle HTTP GET, POST, PUT, and DELETE requests. | ||
|
|
||
| To satisfy the realtime requirement, the demo uses: | ||
| This demo application will come in two flavors. For Node.js, we will select [Express.JS](https://expressjs.com/), and for Rails we will use [Puma](https://github.com/puma/puma). | ||
|
|
||
| - [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API+external) | ||
| - [Upstash for Redis](https://fly.io/docs/reference/redis/) | ||
| * The names of the clips will go into a [PostgreSQL](https://www.postgresql.org/) relational database. | ||
| * The audio files themselves will be placed into a [Tigris bucket](https://www.tigrisdata.com/). | ||
| * For Node.js, the bulk of this code is in [app.js](https://github.com/fly-apps/node-dictaphone/blob/main/app.js). For Rails, | ||
| [app/controller/clipController.rb](https://github.com/fly-apps/rails-dictaphone/blob/main/app/controllers/clips_controller.rb). | ||
|
|
||
| ## Node.js | ||
| To satisfy the realtime requirement, we will need [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) | ||
| and [Upstash for Redis](https://fly.io/docs/reference/redis/). The Node.js implementation is in [pubsub.js](https://github.com/fly-apps/node-dictaphone/blob/main/pubsub.js). | ||
| For Rails, the heavy lifting is done by [ActionCable](https://guides.rubyonrails.org/action_cable_overview.html), so all that is needed is | ||
| one line in [app/models/clip.rb](https://github.com/fly-apps/rails-dictaphone/blob/6bdf4f639640c9fb55530546dbbed682b65a7df9/app/models/clip.rb#L2) | ||
| and one line in [app/views/layouts/application.html.erb](https://github.com/fly-apps/rails-dictaphone/blob/6bdf4f639640c9fb55530546dbbed682b65a7df9/app/views/layouts/application.html.erb#L9). | ||
|
|
||
| The Node.js flavor of the deep dive demo uses an [Express.JS](https://expressjs.com/+external) server. | ||
|
|
||
| If you're looking for specific code: | ||
|
|
||
| * The bulk of the app code is in [app.js](https://github.com/fly-apps/node-dictaphone/blob/main/app.js) | ||
| * The realtime implementation code is in [pubsub.js](https://github.com/fly-apps/node-dictaphone/blob/main/pubsub.js) | ||
|
|
||
| ## Rails | ||
|
|
||
| The Rails flavor of the deep dive demo uses a [Puma](https://github.com/puma/puma+external) server. | ||
|
|
||
| If you're looking for specific code: | ||
| The important thing to note is that this is all very straightforward stuff using industry standard components that you can run on your laptop, a VPS, AWS EC2, Google Compute Engine, or Azure. | ||
|
|
||
| * The bulk of the app code is in [app/controller/clipController.rb](https://github.com/fly-apps/rails-dictaphone/blob/main/app/controllers/clips_controller.rb) | ||
| * The realtime implementation code is primarily in [ActionCable](https://guides.rubyonrails.org/action_cable_overview.html), so all that is needed is one line in [app/models/clip.rb](https://github.com/fly-apps/rails-dictaphone/blob/6bdf4f639640c9fb55530546dbbed682b65a7df9/app/models/clip.rb#L2) | ||
| and one line in [app/views/layouts/application.html.erb](https://github.com/fly-apps/rails-dictaphone/blob/6bdf4f639640c9fb55530546dbbed682b65a7df9/app/views/layouts/application.html.erb#L9) | ||
| If you want to see this up and running on fly.io (and certainly you do or why else would you be here?), all you need | ||
| is an empty directory and either Node or Ruby installed. | ||
|
|
||
| **Next:** Now that you know what you're about to deploy, the next step is running [`fly launch`](../fire/). | ||
| Now that we know what we are intending to accomplish, let's proceed to the exciting step: [Fire!](../fire/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,23 @@ | ||
| --- | ||
| title: Your Fly App | ||
| layout: docs | ||
| nav: demo | ||
| title: Your Application | ||
| layout: framework_docs_overview | ||
| order: 4 | ||
| --- | ||
|
|
||
| Your demo app is running by default on two [Machines](https://fly.io/docs/machines/). | ||
| Your application is running by default on two [Machines](https://fly.io/docs/machines/). | ||
|
|
||
| Both Machines stop when not in use, and [autostart](https://fly.io/docs/launch/autostop-autostart/) when a new request comes in. | ||
| This is entirely configurable. You can chose to [suspend](https://community.fly.io/t/new-feature-in-preview-suspend-resume-for-machines/20672) instead of stop, configure a [minimum number](https://fly.io/docs/reference/configuration/#the-http_service-section) of Machines to leave running, or even decide never to stop Machines at all. | ||
| Don't worry about cost. Both machines stop when not in use, and [autostart](https://fly.io/docs/launch/autostop-autostart/) when a new request comes in. | ||
| This is entirely configurable. You can chose to [suspend](https://community.fly.io/t/new-feature-in-preview-suspend-resume-for-machines/20672) instead of stop, | ||
| configure a [minimum number](https://fly.io/docs/reference/configuration/#the-http_service-section) of machines to leave running, or even decide never to | ||
| stop at all. | ||
|
|
||
| Familiarize yourself with the [fly.toml](https://fly.io/docs/reference/configuration/) config file. Make a change there -- or in fact to any part of your application -- and run `fly deploy`. | ||
| Familiarize yourself with [fly.toml](https://fly.io/docs/reference/configuration/). Make a change there -- or in fact to any part of your application -- and run `fly deploy`. | ||
|
|
||
| The purpose of two Machines is twofold: redundancy and scalability. If the Machine hosting one goes down, the other can continue on. If both are available, in times of high use both can be started to handle requests. | ||
| You can [vertically scale](https://fly.io/docs/launch/scale-machine/) the CPU and RAM on each Machine. | ||
| The purpose of two machines is twofold: redundancy and scalability. If the machine hosting one goes down, the other can continue on. If both are available, in times of high use both can be started to handle requests. | ||
| You can [vertically scale](https://fly.io/docs/launch/scale-machine/) the CPU and RAM on each machine. | ||
|
|
||
| You can also [horizontally scale](https://fly.io/docs/launch/scale-count/) to more Machines. Be sure to scroll down on that page far enough to see how to scale to multiple [regions](https://fly.io/docs/reference/regions/). If you have a co-worker on another continent, create a Machine there. | ||
| You can also [horizontally scale](https://fly.io/docs/launch/scale-count/) to more machines. Be sure to scroll down on that page far enough to see how to scale to | ||
| multiple [regions](https://fly.io/docs/reference/regions/). If you have a co-worker on another continent, create a machine there. | ||
|
|
||
| All this is made possible by [Anycast](https://fly.io/docs/networking/services/), a [load balancing proxy](https://fly.io/docs/reference/fly-proxy/), and [DNS certificates](https://fly.io/docs/networking/custom-domain/). Be sure to read that last link if you're interested in custom domains. | ||
| And all this is made possible by [Anycast](https://fly.io/docs/networking/services/), a [load balancing proxy](https://fly.io/docs/reference/fly-proxy/), and [DNS certificates](https://fly.io/docs/networking/custom-domain/). | ||
| Be sure to read the last link if you are interested in custom domains. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,32 @@ | ||
| --- | ||
| title: Launch the demo | ||
| layout: docs | ||
| nav: demo | ||
| title: Fire | ||
| layout: framework_docs_overview | ||
| order: 3 | ||
| --- | ||
|
|
||
| This is the point where you might expect to see that the marketing hype promised by [Speedrun](https://fly.io/speedrun) doesn't quite cut it. But the fact is that Fly.io is built for an excellent developer experience (DX) for full stack applications with both realtime time and object storage requirements. | ||
| This is the point where the rubber meets the road, so this is where you would expect to see where the marketing hype promised by [Speedrun](https://fly.io/speedrun) and | ||
| the [Quick Start](../getting-started/launch/) don't quite cut it. But the fact of the matter is that fly.io is honed for an excellent developer experience (DX) for full stack applications with both realtime time and object storage requirements. | ||
|
|
||
| There are only two steps. | ||
| There truly are only two steps involved. | ||
|
|
||
| **Step 1:** [Install flyctl](https://fly.io/docs/flyctl/install/). | ||
| Step 1: [install flyctl](https://fly.io/docs/flyctl/install/) | ||
|
|
||
| **Step 2:** Run: | ||
| ```cmd | ||
| fly launch --from https://github.com/fly-apps/node-dictaphone | ||
| ``` | ||
| -or- | ||
| ```cmd | ||
| fly launch --from https://github.com/fly-apps/rails-dictaphone | ||
| ``` | ||
| Step 2: run `fly launch --from https://github.com/fly-apps/node-dictaphone` or `fly launch --from https://github.com/fly-apps/rails-dictaphone` | ||
|
|
||
| If you are new to Fly.io, the second step will take you to a page where you can register before continuing. | ||
| If you are new to fly, the second step will first take you to a place where you can register. Then it will provide a description of what you will be getting, and give you an opportunity to tweak the settings (suggestion: don't. They are fine for this demo and we will walk you through how to adjust them later). And then it will build and assemble and wire up your application. | ||
|
|
||
| The `fly launch` output describes what you'll be getting for the app, and gives you an opportunity to tweak the settings (suggestion: Don't. The defaults are fine for this demo and we'll walk you through how to adjust them later). And then it will build and assemble and wire up your app. | ||
| Take your time and play with it. Open your application in multiple browser windows. Send a link to a friend on another continent and watch your browser update in realtime. | ||
|
|
||
| Take your time and play with it. Open the application in multiple browser windows. Send a link to a friend on another continent and watch your browser update in realtime. | ||
|
|
||
| And then relax. We promised you it would be less than an hour. You're already up and running. If you are so inclined, try bringing up this exact same application on another cloud provider. We don't mind. In fact, we encourage it. Just please don't count the time you spent there against the hour budget we asked you to allot to this activity. | ||
|
|
||
| Once you're back and/or rested up, explore app and add-on components. Feel free to review the following in any order, or chose to skip ahead: | ||
| And then relax. We promised you it would be less than an hour. You are already up and running. In fact, if you are so inclined try bringing up this exact same application on another cloud provider. | ||
| We don't mind. In fact we encourage it. Just please don't count the time you spent there against the hour budget we asked you to allot to this activity. | ||
|
|
||
| Once you are back and/or rested up, let's explore. You've seen the code. You're up and running. Now lets take inventory. | ||
| Feel free to review the following in any order, or chose to skip ahead: | ||
| * [Your application](../application/) | ||
| * [PostgreSQL](../postgresql/) | ||
| * [Tigris](../tigris/) | ||
| * [Redis](../redis/) | ||
|
|
||
| Finally, as an added treat, you can add some AI functionality, in this case speech recognition using [Whisper](../whisper/). | ||
| Finally, as an added treat and as promised, let's add some AI functionality, in this case speech recognition using [Whisper](../whisper/). | ||
|
|
||
| When you're all done, visit the [recap](../recap). | ||
| And when you are done, join us for a [recap](../recap) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,33 @@ | ||
| --- | ||
| title: Deep dive demo | ||
| layout: docs | ||
| nav: demo | ||
| title: The Happy Path | ||
| layout: framework_docs | ||
| toc: false | ||
| --- | ||
|
|
||
| You probably landed on this page because somebody recommended Fly.io to you. You're curious, and you want to know more before you commit. | ||
| You landed on this page because somebody recommended fly.io to you, | ||
| you are a bit curious, but you want to know more before you commit. | ||
|
|
||
| If you came from our [Speedrun](https://fly.io/speedrun) or [Getting started](https://fly.io/docs/getting-started/) pages, maybe you want to not only be up and running fast, you want to feel confident that you're making a good decision; choosing a platform that can both support you now, and scale with you later on as you grow. | ||
| You are aware that there is a [Speedrun](https://fly.io/speedrun) and | ||
| a [Quick Start](../getting-started/launch/), but perhaps they feel a bit | ||
| too _Ready! Fire! Aim!_ for you. You want to not only be up and running, | ||
| you want to feel confident that you are heading in the right direction. A | ||
| direction that can both scale and support your present and future needs. | ||
|
|
||
| Maybe you're concerned about lock in. You want to know that you can | ||
| You are concerned about lock in. You want to be confident that you can | ||
| use services from other places and even eject entirely and move your entire | ||
| application elsewhere if things don't work out. | ||
|
|
||
| If you want to explore more deeply but in a time-boxed way, then you're in the right place. You should be up and running within minutes, and have enough of the hour left over to spend some time understanding what you just did and run a few commands and see what they do. | ||
| But most of all, you want to explore in a time boxed way as you are | ||
| a busy person. If you don't get a good feeling within an hour, you are out | ||
| of here. If you do have a good feeling, then perhaps you'd consider | ||
| sticking around for even deeper dives into areas that interest you. | ||
|
|
||
| If you don't get a good feeling within an hour, you're out of here. If you do get a good feeling, then consider | ||
| sticking around to experiment and learn more about features that interest you. And when you're done, you can delete everything and launch the application that you brought here to launch. | ||
| If so, you have come to the right place. You should be up and | ||
| running within minutes, and have enough of the hour left over so | ||
| that you can spend some time understanding what you just did and | ||
| run a few commands and see what they do. | ||
|
|
||
| **Next:** [Beyond `hello fly`](/docs/happy-path/ready/) | ||
| And when you are done, you can delete everything and then launch the | ||
| application that you came here for. | ||
|
|
||
| Let's get started... [Ready](./ready/) ... [Aim](./aim/) ... [Fire](./fire/)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| --- | ||
| title: PostgreSQL | ||
| layout: docs | ||
| layout: framework_docs_overview | ||
| order: 5 | ||
| nav: demo | ||
| --- | ||
|
|
||
| Fly Postgres is deployed as a separate app, and that app comes initially configured with a single [Fly Postgres](https://fly.io/docs/postgres/) Machine. That's fine for development, but for production you need redundancy and scalability. With a [few commands](https://fly.io/docs/postgres/advanced-guides/high-availability-and-global-replication/) you can create an HA cluster in your primary region and read-only replicas elsewhere. | ||
| Your application comes initially configured for a single [Fly Postgres](https://fly.io/docs/postgres/) machine. | ||
| That is great for development, but for production we need redundancy and scalability. With but a [few commands](https://fly.io/docs/postgres/advanced-guides/high-availability-and-global-replication/) we can create a HA cluster in my primary region and read only replicas elsewhere. | ||
|
|
||
| If you're interested in a managed offering, [Supabase Postgres](https://fly.io/docs/reference/supabase/) is in public alpha. | ||
| If you are interested in a managed offering, [Supabase Postgres](https://fly.io/docs/reference/supabase/) is in public alpha. | ||
|
|
||
| And there is no lock in here. We have a list of [recommended external providers](https://fly.io/docs/postgres/getting-started/what-you-should-know/#recommended-external-providers), but you're free to host your database literally anywhere. | ||
| And there is no lock in here. We have a list of [recommended external providers](https://fly.io/docs/postgres/getting-started/what-you-should-know/#recommended-external-providers), but you are free to host your database literally anywhere. | ||
|
|
||
| Before moving on, one last observation on the relational database. While you want and need your application to be on the internet, you are much better off if your relational database is NOT directly exposed to the internet, but can only be accessed via your application. That’s the value of an [internal private network](https://fly.io/docs/networking/private-networking/). The private connection from the demo app to the Postgres app was configured automatically for you. | ||
| Before moving on, one last observation on the relational DB. While you want and need your application to be on the internet, you are much better off if your relational database is NOT directly exposed to the internet, but can only be accessed via your application. That’s the value of an [internal private network](https://fly.io/docs/networking/private-networking/). This too was configured automatically for you. |
Oops, something went wrong.