221 | The Pro tier includes 3 premium projects and unlimited free
222 | projects. Free projects have limited resources and cold starts, but
223 | cost you nothing to run.
224 |
225 |
226 |
227 | Every premium project comes with an included amount of usage. If
228 | your project scales beyond these limits, you pay for any additional
229 | resources as you go.
230 |
105 | ))
106 | TableCaption.displayName = "TableCaption"
107 |
108 | export {
109 | Table,
110 | TableHeader,
111 | TableBody,
112 | TableFooter,
113 | TableHead,
114 | TableRow,
115 | TableCell,
116 | TableCaption,
117 | }
118 |
--------------------------------------------------------------------------------
/components/ui/tooltip.tsx:
--------------------------------------------------------------------------------
1 | import * as React from "react"
2 | import * as TooltipPrimitive from "@radix-ui/react-tooltip"
3 |
4 | import { cn } from "@/src/utils"
5 |
6 | const TooltipProvider = TooltipPrimitive.Provider
7 |
8 | const Tooltip = TooltipPrimitive.Root
9 |
10 | const TooltipTrigger = TooltipPrimitive.Trigger
11 |
12 | const TooltipContent = React.forwardRef<
13 | React.ElementRef,
14 | React.ComponentPropsWithoutRef
15 | >(({ className, sideOffset = 4, ...props }, ref) => (
16 |
25 | ))
26 | TooltipContent.displayName = TooltipPrimitive.Content.displayName
27 |
28 | export { Tooltip, TooltipTrigger, TooltipContent, TooltipProvider }
29 |
--------------------------------------------------------------------------------
/next-env.d.ts:
--------------------------------------------------------------------------------
1 | ///
2 | ///
3 |
4 | // NOTE: This file should not be edited
5 | // see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.
6 |
--------------------------------------------------------------------------------
/next-sitemap.config.js:
--------------------------------------------------------------------------------
1 | /** @type {import('next-sitemap').IConfig} */
2 | module.exports = {
3 | siteUrl: 'https://www.celest.dev',
4 | generateRobotsTxt: false,
5 | };
--------------------------------------------------------------------------------
/next.config.mjs:
--------------------------------------------------------------------------------
1 | // @ts-check
2 | import { withSentryConfig } from "@sentry/nextjs";
3 | import nextra from "nextra";
4 |
5 | /** @type {import('nextra/types').NextraConfig} */
6 | const nextraConfig = {
7 | theme: "nextra-theme-docs",
8 | themeConfig: "./theme.config.tsx",
9 | staticImage: true,
10 | flexsearch: {
11 | codeblocks: false,
12 | },
13 | codeHighlight: true,
14 | };
15 |
16 | /**
17 | * @type {import('next').NextConfig}
18 | */
19 | export default withSentryConfig(
20 | nextra(nextraConfig)({
21 | redirects: () => [
22 | {
23 | source: "/docs/functions/introduction",
24 | destination: "/docs/functions",
25 | statusCode: 301,
26 | },
27 | {
28 | source: "/docs/auth/introduction",
29 | destination: "/docs/auth",
30 | statusCode: 301,
31 | },
32 | {
33 | source: "/blog/local-iterations-mvp",
34 | destination: "/blog/local-iterations-release",
35 | statusCode: 301,
36 | },
37 | {
38 | source: "/download",
39 | destination: "/docs/download",
40 | statusCode: 302,
41 | },
42 | {
43 | source: "/docs/functions/http-requests",
44 | destination: "/docs/functions/http/conventions",
45 | statusCode: 301,
46 | },
47 | {
48 | source: "/docs/overview",
49 | destination: "/docs",
50 | statusCode: 301,
51 | },
52 | {
53 | source: "/about-us",
54 | destination: "/",
55 | statusCode: 302,
56 | },
57 | {
58 | // Found in the wild... Googlebot was trying to access this URL
59 | source: '/See',
60 | destination: '/',
61 | statusCode: 301,
62 | },
63 | {
64 | source: '/pricing',
65 | destination: '/docs/cloud',
66 | statusCode: 302,
67 | },
68 | {
69 | source: '/docs/cloud/pricing',
70 | destination: '/docs/cloud',
71 | statusCode: 302,
72 | },
73 | {
74 | source: '/tos',
75 | // The is the more common URL
76 | destination: '/terms',
77 | statusCode: 301,
78 | }
79 | ],
80 | }),
81 | {
82 | // For all available options, see:
83 | // https://github.com/getsentry/sentry-webpack-plugin#options
84 |
85 | org: "celest",
86 | project: "javascript",
87 |
88 | // Only print logs for uploading source maps in CI
89 | silent: !process.env.CI,
90 |
91 | // For all available options, see:
92 | // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
93 |
94 | // Upload a larger set of source maps for prettier stack traces (increases build time)
95 | widenClientFileUpload: true,
96 |
97 | // Route browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.
98 | // This can increase your server load as well as your hosting bill.
99 | // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
100 | // side errors will fail.
101 | tunnelRoute: "/monitoring",
102 |
103 | // Hides source maps from generated client bundles
104 | hideSourceMaps: true,
105 |
106 | // Automatically tree-shake Sentry logger statements to reduce bundle size
107 | disableLogger: true,
108 |
109 | // Enables automatic instrumentation of Vercel Cron Monitors. (Does not yet work with App Router route handlers.)
110 | // See the following for more information:
111 | // https://docs.sentry.io/product/crons/
112 | // https://vercel.com/docs/cron-jobs
113 | automaticVercelMonitors: true,
114 |
115 | telemetry: false,
116 | }
117 | );
118 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "celest-docs",
3 | "private": true,
4 | "description": "Documentation for Celest",
5 | "scripts": {
6 | "dev": "next dev",
7 | "build": "next build",
8 | "postbuild": "next-sitemap",
9 | "start": "next start"
10 | },
11 | "repository": {
12 | "type": "git",
13 | "url": "git+https://github.com/celest-dev/website.git"
14 | },
15 | "author": "Celest ",
16 | "bugs": {
17 | "url": "https://github.com/celest-dev/website/issues"
18 | },
19 | "homepage": "https://www.celest.dev",
20 | "dependencies": {
21 | "@calcom/embed-react": "^1.5.3",
22 | "@fortawesome/fontawesome-svg-core": "^6.7.2",
23 | "@fortawesome/free-solid-svg-icons": "^6.7.2",
24 | "@fortawesome/react-fontawesome": "^0.2.2",
25 | "@heroicons/react": "^2.2.0",
26 | "@intercom/messenger-js-sdk": "^0.0.6",
27 | "@radix-ui/react-accordion": "^1.2.10",
28 | "@radix-ui/react-dialog": "^1.1.13",
29 | "@radix-ui/react-hover-card": "^1.1.13",
30 | "@radix-ui/react-slot": "^1.2.2",
31 | "@radix-ui/react-tooltip": "^1.2.6",
32 | "@sentry/nextjs": "^9.17.0",
33 | "@vercel/og": "^0.6.8",
34 | "@vercel/speed-insights": "^1.2.0",
35 | "class-variance-authority": "^0.7.1",
36 | "clsx": "^2.1.1",
37 | "embla-carousel-autoplay": "^8.6.0",
38 | "embla-carousel-react": "^8.6.0",
39 | "lucide-react": "^0.378.0",
40 | "next": "^15.3.2",
41 | "nextra": "^2.13.4",
42 | "nextra-theme-docs": "^2.13.4",
43 | "posthog-js": "^1.240.6",
44 | "react": "~18.2.0",
45 | "react-dom": "~18.2.0",
46 | "react-icons": "^5.5.0",
47 | "recharts": "^2.15.3",
48 | "sharp": "^0.33.5",
49 | "shiki": "^0.14.7",
50 | "tailwind-merge": "^2.6.0",
51 | "tailwindcss-animate": "^1.0.7"
52 | },
53 | "devDependencies": {
54 | "@types/node": "18.11.10",
55 | "@types/react": "~18.2.79",
56 | "autoprefixer": "^10.4.21",
57 | "next-sitemap": "^4.2.3",
58 | "postcss": "^8.5.3",
59 | "tailwindcss": "^3.4.17",
60 | "typescript": "^4.9.5"
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/pages/404.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Not Found
3 | description: The page you're looking for doesn't exist in Celest.
4 | ---
5 |
6 | # Not Found
7 |
8 | Whoops! The page you're looking for doesn't exist. Go back to the [homepage](/) or [contact us](/contact) if you need help.
9 |
10 |
--------------------------------------------------------------------------------
/pages/_app.mdx:
--------------------------------------------------------------------------------
1 | import App from '@components/_app';
2 |
3 | import '../styles.css';
4 | import "nextra-theme-docs/style.css";
5 |
6 | export default App;
7 |
--------------------------------------------------------------------------------
/pages/_error.mdx:
--------------------------------------------------------------------------------
1 | import Error from '@components/_error'
2 |
3 |
4 |
--------------------------------------------------------------------------------
/pages/_meta.json:
--------------------------------------------------------------------------------
1 | {
2 | "index": {
3 | "title": "Home",
4 | "type": "page",
5 | "display": "hidden",
6 | "theme": {
7 | "sidebar": false,
8 | "toc": false
9 | }
10 | },
11 | "docs": {
12 | "title": "Docs",
13 | "type": "page"
14 | },
15 | "blog": {
16 | "title": "Blog",
17 | "type": "page",
18 | "theme": {
19 | "typesetting": "article",
20 | "breadcrumb": false,
21 | "sidebar": false
22 | }
23 | },
24 | "discord": {
25 | "title": "Discord",
26 | "type": "page",
27 | "display": "hidden"
28 | },
29 | "404": {
30 | "title": "404",
31 | "type": "page",
32 | "display": "hidden",
33 | "theme": {
34 | "breadcrumb": false,
35 | "sidebar": false,
36 | "toc": false
37 | }
38 | },
39 | "_error": {
40 | "title": "Error",
41 | "type": "page",
42 | "display": "hidden",
43 | "theme": {
44 | "breadcrumb": false,
45 | "sidebar": false,
46 | "toc": false
47 | }
48 | }
49 | }
--------------------------------------------------------------------------------
/pages/api/og.tsx:
--------------------------------------------------------------------------------
1 | import { ImageResponse } from "@vercel/og";
2 | import { NextRequest } from "next/server";
3 |
4 | export const config = {
5 | runtime: "edge",
6 | };
7 |
8 | export default async function handler(request: NextRequest) {
9 | try {
10 | const { searchParams } = new URL(request.url);
11 |
12 | const poppins = await fetch(
13 | new URL("../../public/fonts/Poppins/Poppins-Regular.ttf", import.meta.url)
14 | ).then((res) => res.arrayBuffer());
15 | const poppinsBold = await fetch(
16 | new URL(
17 | "../../public/fonts/Poppins/Poppins-Medium.ttf",
18 | import.meta.url
19 | )
20 | ).then((res) => res.arrayBuffer());
21 | const berkeleyMono = await fetch(
22 | new URL(
23 | "../../public/fonts/BerkeleyMono-Regular.ttf",
24 | import.meta.url
25 | )
26 | ).then((res) => res.arrayBuffer());
27 |
28 | const logo = await fetch(
29 | new URL("../../public/img/logo-white.png", import.meta.url)
30 | ).then((res) => res.arrayBuffer());
31 | const logoUri = `data:image/png;base64,${Buffer.from(logo).toString(
32 | "base64"
33 | )}`;
34 |
35 | // ?title=
36 | let title = searchParams.get("title");
37 | if (title) {
38 | title = title.split(" | ")[0].trim().slice(0, 100);
39 | }
40 |
41 | return new ImageResponse(
42 | (
43 | <div
44 | style={{
45 | height: "100%",
46 | width: "100%",
47 | display: "flex",
48 | flexDirection: "column",
49 | alignItems: "center",
50 | justifyContent: "center",
51 | background:
52 | "linear-gradient(115deg, #010512 26.96%, #121f30 80%)",
53 | color: "white",
54 | fontFamily: "Berkeley Mono, Poppins, sans-serif",
55 | textAlign: "center",
56 | }}
57 | >
58 | <div
59 | style={{
60 | display: "flex",
61 | flexDirection: "row",
62 | justifyContent: "center",
63 | alignItems: "center",
64 | }}
65 | >
66 | <img
67 | src={logoUri}
68 | alt="Celest Logo"
69 | style={{
70 | width: 200,
71 | height: 200,
72 | objectFit: "contain",
73 | }}
74 | />
75 | <div
76 | style={{
77 | paddingTop: 24,
78 | marginLeft: 24,
79 | fontSize: 130,
80 | fontWeight: 500,
81 | fontFamily: 'Poppins',
82 | }}
83 | >
84 | Celest
85 | </div>
86 | </div>
87 | {title && (
88 | <div style={{ marginTop: 28, fontSize: 56, maxWidth: "50%" }}>
89 | {title}
90 | </div>
91 | )}
92 | <div style={{ marginTop: 28, fontSize: 24 }}>
93 | The Flutter cloud platform
94 | </div>
95 | <div style={{ marginTop: 12, fontSize: 24, color: 'white' }}>∞ celest.dev</div>
96 | </div>
97 | ),
98 | {
99 | width: 1200,
100 | height: 630,
101 | fonts: [
102 | {
103 | name: "Poppins",
104 | data: poppins,
105 | style: "normal",
106 | weight: 400,
107 | },
108 | {
109 | name: "Poppins",
110 | data: poppinsBold,
111 | style: "normal",
112 | weight: 600,
113 | },
114 | {
115 | name: "Berkeley Mono",
116 | data: berkeleyMono,
117 | style: "normal",
118 | weight: 400,
119 | },
120 | ],
121 | }
122 | );
123 | } catch (error) {
124 | console.error(`Failed to generate the image: ${error}`);
125 | return new Response(`Failed to generate the image`, {
126 | status: 500,
127 | });
128 | }
129 | }
130 |
--------------------------------------------------------------------------------
/pages/blog.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Blog
3 | ---
4 |
5 | <h1 className="text-4xl tracking-tighter text-center font-extrabold md:text-5xl mt-8 pb-6">Celest Blog</h1>
6 |
7 | import BlogIndex from '@components/BlogIndex'
8 |
9 | <BlogIndex/>
10 |
--------------------------------------------------------------------------------
/pages/blog/how-we-want-to-backend.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: How we want to backend
3 | description: How we reason about Celest's design and our wants for the future of backend development.
4 | date: May 28, 2024
5 | order: 1
6 | ---
7 |
8 | import { Callout } from 'nextra/components';
9 | import { Bleed } from 'nextra-theme-docs';
10 | import Image from 'next/image';
11 |
12 | import Authors, { Author } from '@components/Authors'
13 | import annotateAllTheThings from '@/public/img/annotate-all-the-things.jpeg';
14 |
15 | # How we want to backend
16 |
17 | <Authors />
18 |
19 | Today, we're excited to release version 0.4 of Celest, including support for HTTP customization, improved ergonomics, and a preview of running
20 | Flutter and UI code in the sky! We've published a separate [blog](/blog/fluttering-in-the-sky) post to discuss all the
21 | new features. In this post, we want to dive into more of the design of Celest and the principles that guide it.
22 |
23 | <Image className="m-auto pt-8 pb-4 w-7/12" alt="Annotate all the things" src={annotateAllTheThings} />
24 |
25 | As you build with Celest, you'll notice that it requires a slightly different way of thinking about your backend.
26 | This article walks through how we arrived at the design of Celest and what we're trying to achieve.
27 |
28 | The first thing you'll notice is Celest's liberal usage of Dart [annotations](https://dart.dev/language/metadata).
29 | Annotations are used in Celest to convey almost all the metadata and semantics of your backend.
30 |
31 | ```dart
32 | @cloud
33 | @authenticated
34 | Future<String> sayHello({
35 | @principal required User user,
36 | }) async {
37 | return 'Hello, ${user.displayName}';
38 | }
39 | ```
40 |
41 | At first glance, this syntax can seem cumbersome and you may wonder why this design decision was made.
42 |
43 | Our goals for Celest are two-fold:
44 | 1. To have you write the least amount of boilerplate code possible, letting us do the heavy lifting; and
45 | 2. To let you convey the semantics of your backend precisely and unambiguously.
46 |
47 | Annotations allow us to achieve both these goals, _if_ we do it right.
48 |
49 | > And if we ever don't, please let us know! API design and naming can be especially tricky to get right,
50 | > and we're by no means perfect.
51 |
52 | ## Declarative backends
53 |
54 | The first thing annotations do is enable you to think about your backend declaratively. Instead of telling
55 | Celest how to do something, you tell Celest what you want to do and let it figure out the best way possible.
56 |
57 | For example, instead of writing code to set up an HTTP server, you annotate your logic with `@cloud`.
58 |
59 | ```dart
60 | @cloud
61 | Future<String> sayHello() async {
62 | return 'Hello, world!';
63 | }
64 | ```
65 |
66 | Instead of writing code to handle authentication via middleware or a proxy, you label your protected logic
67 | with `@authenticated`.
68 |
69 | ```dart
70 | @cloud
71 | @authenticated
72 | Future<String> sayHello() async {
73 | return 'Hello, valued customer!';
74 | }
75 | ```
76 |
77 | Celest has built-in opinions on how to handle each of these cases which optimize the performance and security of your backend.
78 | In the cases where you know better than us, we expose additional annotations to override our defaults (e.g. with
79 | [HTTP customizations](/docs/functions/http/customization)) while stll minimizing the boilerplate.
80 |
81 | Either way, Celest allows you to convey the _intent_ of how some code should work without worrying about
82 | exactly _how_ it is done unless you want to.
83 |
84 | ### Sane defaults
85 |
86 | Being so opinionated means that if we have the wrong opinions, you'll end up writing customizations for everything you're building,
87 | completely defeating our sole mission. To avoid this, we've tried to make our default behavior _sane_.
88 |
89 | Sane default behavior means that the "magic" Celest does is what you probably would have done anyway. It's what your intuition would suggest is
90 | happening. And it has baked in the current best practices around design and security.
91 |
92 | Let's take `@authenticated` as an example. When you see a function labeled as such, you would expect that only users who have passed through a login
93 | flow, and have a valid login session, can access it. You would intuit this information is being conveyed via some HTTP header like `Authorization`. And
94 | best practices would suggest that any function _not_ labeled as `@authenticated` be deny-by-default.
95 |
96 | All of this is true for `@authenticated` and these are the ways we try to reason about every annotation.
97 |
98 | ## Infrastructure from code
99 |
100 | When it comes time to deploy that backend, the current trend is to write your infrastructure as code (the IaC paradigm) in order to have declarative,
101 | reproducible, and auditable deployments. To do this, you would typically introduce a new codebase to store your infrastructure which lives alongside your backend.
102 |
103 | For example, you may have a backend written in Node.js and scaffold out your infrastructure in Terraform.
104 |
105 | <Bleed>
106 | <div className="flex flex-row flex-wrap items-center justify-center">
107 | <div className="px-2">
108 | ```js filename="index.js"
109 | export function handler(event, context) {
110 | console.log("Got event:", event);
111 | };
112 | ```
113 | </div>
114 | <div className="px-2">
115 | ```hcl filename="main.tf"
116 | resource "aws_lambda_function" "example" {
117 | function_name = "example"
118 | handler = "index.handler"
119 | runtime = "nodejs14.x"
120 | role = aws_iam_role.example.arn
121 | }
122 | ```
123 | </div>
124 | </div>
125 | <p className="mt-2 text-sm text-gray-400 text-center">An example Node.js Lambda function and the Terraform to deploy it.</p>
126 | </Bleed>
127 |
128 | Much like Celest, this allows you to _declare_ the components of your infrastructure instead of imperatively creating, updating, and deleting
129 | them by hand. And for a while, it works great!
130 |
131 | The split of backend and infrastructure logic creates fragmentation in your codebase, though. As your project scales, some hairy issues start to emerge:
132 |
133 | - Features must be written and coordinated twice: once in the backend and again for the corresponding infrastructure.
134 | - The infrastructure code can become out-of-date with the backend code, leading to bugs and security vulnerabilities.
135 | - Understanding the infrastructure that controls a piece of backend code requires jumping between two, possibly distinct, codebases.
136 |
137 | At Celest, we've experienced all these problems and more. And through that pain, we've come to believe that the best way to write infrastructure is to
138 | write it _alongside_ the code it manages. Ideally, everything relevant to a piece of backend code should live right next to it
139 | in the same file, function, and language.
140 |
141 | > This paradigm has been coined infrastructure-**from**-code (IfC), as opposed to the
142 | > infrastructure-as-code pattern described previously.
143 |
144 | ```dart
145 | @cloud
146 | @authenticated
147 | Future<String> sayHello() async {
148 | return 'Hello, valued customer!';
149 | }
150 | ```
151 |
152 | Adopting this paradigm, you need only look at the function itself to understand both its logic and its infrastructure.
153 | No other files, languages, or teams are required.
154 |
155 | On the surface, it may seem that this leads to more friction when trying to understand any piece of backend code. But because there still exists
156 | a clean separation of your backend and infrastructure (i.e. runtime vs. static code), you can safely ignore one or the other to process each part in isolation.
157 |
158 | And whenever you need to update a part of your backend, you can do so in a single place.
159 |
160 | We think that's powerful!
161 |
162 | ## Blurring the lines even more
163 |
164 | But why stop there? What if you could not only keep your backend and infrastructure code together but also your client code?
165 |
166 | Currently, in Celest, everything must be done in a separate `celest` folder which lives outside your client app. Your backend types and logic are all
167 | separate from your client code and, because they live in a separate Dart package, you must follow Dart package conventions to share them with your frontend.
168 |
169 | For example, Celest requires that all your shared code live in the `lib` folder of your Celest project. But this, too, can create friction when you're
170 | working on a piece of frontend code and realize you need to update the backend.
171 |
172 | Imagine you're working on this Dart application and decide you want the `sayHello` function to run only in the backend.
173 |
174 | ```dart
175 | Future<String> sayHello() async {
176 | return 'Hello, world!';
177 | }
178 |
179 | void main() async {
180 | print(await sayHello());
181 | }
182 | ```
183 |
184 | You would have to move the function to your Celest project, import the generated client into your frontend project, and update your frontend to call the Celest client.
185 | Hopefully, it all goes as planned.
186 |
187 | What if, instead, you could just do this?
188 |
189 | ```dart {1}
190 | @cloud
191 | Future<String> sayHello() async {
192 | return 'Hello, world!';
193 | }
194 |
195 | void main() async {
196 | print(await sayHello());
197 | }
198 | ```
199 |
200 | That's how we want to backend. Over the next few months, you'll see more work to blur these lines with IDE plugins, better Dart analyzer support, and macros 👀. To learn
201 | more about the features available today with Celest 0.4, check out the launch [post](/blog/fluttering-in-the-sky).
202 |
203 | We'd love to hear your thoughts on this vision for backend development. Reach out to us on [GitHub](https://github.com/celest-dev/celest), [X](https://x.com/celest_dev), and [Discord](/discord)!
204 |
205 | Dart on! 🚀
206 |
--------------------------------------------------------------------------------
/pages/blog/local-iterations-release.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | slug: local-iterations-release
3 | title: First CLI release for local iterations
4 | description: "It's with immense excitement that we write our first blog post announcing the first release of the Celest CLI, enabling you to experience Celest and build a backend locally!"
5 | date: January 22, 2024
6 | ---
7 |
8 | import Authors, { Author } from '@components/Authors'
9 |
10 | # First CLI release for Local Iterations
11 |
12 | <Authors />
13 |
14 | It's with immense excitement that we write our first blog post announcing the first release of the Celest CLI, enabling you to experience Celest and build a backend locally! But today is not just about introducing our product—it’s about sharing our dream and vision with the community that we cherish deeply.
15 |
16 | Celest is a backend-as-a-service that enables Flutter developers to build their backends in Dart, without any additional tooling. With this release, we are making our CLI and Celest Functions available to you to build and experiment with locally. In response to the excited reaction we’ve received from the Flutter community, we chose to release this version now so that we can give you a taste of the Celest experience and get your feedback early.
17 |
18 | Check out our video that walks you through the Celest experience!
19 |
20 | <div id="intro-video" className="flex items-center justify-center my-4">
21 | <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Zm4v_8XFHh4?si=o-kvdfdtd7ScnQSs" title="Our first release! Iterate on your backend locally" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen></iframe>
22 | </div>
23 |
24 | ## Why use Celest?
25 |
26 | Celest and its Functions offering enable you to write custom business logic in Dart that runs in the cloud. Celest Functions is the first "Cloud Widget" we are introducing to help bridge the gap of building backend components completely in Dart. Since Celest Functions are just Dart functions, they enable you to reuse code between your Flutter app and your backend with full type safety between the two. All of the third-party packages you're familiar with from the Dart ecosystem can now be used in your backend.
27 |
28 | With Celest Functions and the CLI, you get a type-safe API layer between your business logic in the cloud and the UI of your Flutter app. When developing locally, your changes are available instantly via our hot-reload mechanism. This makes it easier to iterate quickly while adding features to your backend and ship to your customers _fast_.
29 |
30 | In future releases, Celest will handle the deployment and management of your functions' underlying infrastructure.
31 |
32 | ## What's next for Celest?
33 |
34 | We can't wait to share more updates and continue building Celest with you. We’re on this adventure together. Your thoughts, feedback, and ideas are what will shape Celest’s future the most.
35 |
36 | Our next action items are creating a public roadmap, RFCs for Authorization and Real-Time Patterns, and enabling cloud deployments for all Celest users.
37 |
38 | Visit our [documentation](/docs) to learn more about this new release and to get started with the CLI and Celest Functions. Join our [Discord server](/discord) to give us feedback about your experience with this or future releases and connect with other Flutter and Dart enthusiasts. And let us know on [GitHub](https://github.com/celest-dev/celest) if there are any features you'd like to see or if you get stuck at any point.
39 |
40 | <div style={{ lineHeight: "0.75rem" }}>
41 | <br />
42 | Cheers to New Beginnings!
43 | <br />
44 |
45 | **Dillon Nys & Abdallah Shaban**
46 |
47 | Co-founders, Celest
48 | </div>
--------------------------------------------------------------------------------
/pages/compliance.mdx:
--------------------------------------------------------------------------------
1 | import Compliance from '@components/compliance'
2 |
3 | <Compliance />
4 |
--------------------------------------------------------------------------------
/pages/discord.mdx:
--------------------------------------------------------------------------------
1 | import Discord from '@components/discord'
2 |
3 | <Discord />
4 |
--------------------------------------------------------------------------------
/pages/docs/_meta.json:
--------------------------------------------------------------------------------
1 | {
2 | "index": "What is Celest?",
3 | "get-started": "Getting Started",
4 | "download": "Download",
5 | "--celest": {
6 | "title": "Celest",
7 | "type": "separator"
8 | },
9 | "functions": "Functions",
10 | "auth": "Auth",
11 | "data": "Data",
12 | "--hosting": {
13 | "title": "Hosting",
14 | "type": "separator"
15 | },
16 | "self-hosting": "Self-Hosting",
17 | "--reference": {
18 | "title": "Reference",
19 | "type": "separator"
20 | },
21 | "folder-structure": "Folder Structure",
22 | "api-reference": {
23 | "title": "API Reference",
24 | "href": "https://pub.dev/documentation/celest/latest/",
25 | "newWindow": true
26 | },
27 | "cli-commands-reference": "CLI commands",
28 | "contact": {
29 | "title": "Contact ↗",
30 | "type": "page",
31 | "href": "https://x.com/Celest_Dev",
32 | "newWindow": true
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/pages/docs/auth.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Auth
3 | description: Learn how to add authentication to your Celest project.
4 | ---
5 |
6 | # Auth
7 |
8 | Celest comes with built-in auth support via our [Cloud Auth](https://github.com/celest-dev/celest/tree/main/services/celest_cloud_auth) package: an open-source, Dart-native service for
9 | authenticating and authorizing users in any Dart backend.
10 |
11 | <div className="flex flex-row justify-around items-center">
12 | <img src="https://github.com/cedar-policy/.github/raw/main/profile/logo.svg" alt="Cedar Logo" className="h-full m-2 p-8 w-1/2" />
13 | <img src="https://www.sqlite.org/images/sqlite370_banner.gif" alt="SQLite Logo" className="h-full m-2 p-8 w-1/2" />
14 | </div>
15 |
16 | Cloud Auth is built on top of the [Cedar](https://www.cedarpolicy.com/en) policy engine and [SQLite](https://www.sqlite.org/) to both manage user accounts
17 | and enforce consistent access controls in a single Dart package. The Celest CLI will automatically integrate Cloud Auth into your project when
18 | using Celest Auth, but the service is exposed as a Shelf router and middleware which can be used in any Dart project.
19 |
20 | To get started with Cloud Auth, continue to the next page to see how to add it to your Celest project 🚀
21 |
22 | > Celest Auth also suppors integrating [Supabase](./auth/supabase-auth.mdx) and [Firebase](./auth/firebase-auth.mdx) for cases where you
23 | > already have an existing user base.
24 |
--------------------------------------------------------------------------------
/pages/docs/auth/_meta.json:
--------------------------------------------------------------------------------
1 | {
2 | "celest-auth": "Celest Auth",
3 | "using-the-auth-client": "Using the Auth client",
4 | "--external": {
5 | "title": "External Providers",
6 | "type": "separator"
7 | },
8 | "firebase-auth": "Firebase Auth",
9 | "supabase-auth": "Supabase Auth"
10 | }
11 |
--------------------------------------------------------------------------------
/pages/docs/auth/celest-auth.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Celest Auth
3 | description: Learn how to use Celest's built-in Cloud Auth for authenticating users in your Celest project.
4 | ---
5 |
6 | import { Callout } from 'nextra-theme-docs'
7 |
8 | # Celest Auth
9 |
10 | Adding Auth to your Celest project takes 5 lines of code. In your `project.dart` file, add the following code:
11 |
12 | ```dart {5-9} copy filename="celest/lib/src/project.dart"
13 | import 'package:celest/celest.dart';
14 |
15 | const project = Project(name: 'my-project');
16 |
17 | const auth = Auth(
18 | providers: [
19 | AuthProvider.email(),
20 | ],
21 | );
22 | ```
23 |
24 | That's it! When you run `celest start`, Celest will automatically integrate our open-source Auth backend
25 | [Cloud Auth](https://github.com/celest-dev/celest/tree/main/services/celest_cloud_auth) and generate an Auth
26 | client for you to use in your Flutter app.
27 |
--------------------------------------------------------------------------------
/pages/docs/auth/firebase-auth.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Firebase Auth
3 | description: Learn how to use Firebase Auth for authenticating users in your Celest project.
4 | ---
5 |
6 | import { Callout } from 'nextra-theme-docs'
7 |
8 | # Firebase Auth
9 |
10 | If you're migrating to Celest from another framework, chances are you already have a user base that you'd like to use.
11 |
12 | As of Celest V1, Firebase can be used as your auth provider in Celest. And doing so is just as easy as with Celest's built-in auth.
13 |
14 | ## In your Celest project
15 |
16 | To use Firebase as your auth provider, add the following code to your `project.dart` file:
17 |
18 | ```dart copy filename="celest/lib/src/project.dart"
19 | import 'package:celest/celest.dart';
20 |
21 | const project = Project(name: 'firebase');
22 |
23 | const auth = Auth(
24 | providers: [
25 | ExternalAuthProvider.firebase(),
26 | ],
27 | );
28 | ```
29 |
30 | Verifying users with Firebase requires knowing your Firebase project ID. When you run `celest start`, Celest will automatically search your environment for
31 | any available Firebase projects. If it can't figure out which project to use, you'll be prompted to enter it manually.
32 |
33 | Celest will securely store your Firebase project ID for future use so it doesn't need to prompt you again.
34 |
35 | ## In your Flutter app
36 |
37 | In your Flutter app, Celest will listen for changes to Firebase's auth state and update the Celest state accordingly so that
38 | calls to your Cloud Functions are authenticated appropriately.
39 |
40 | To do so, it needs access to your Firebase client, which you pass into the `celest.init` call in your `main` function.
41 |
42 | ```dart copy filename="lib/main.dart"
43 | import 'package:firebase_auth/firebase_auth.dart';
44 | import 'package:firebase_core/firebase_core.dart';
45 | import 'package:flutter/material.dart';
46 | import 'package:my_project_client/my_project_client.dart';
47 |
48 | Future<void> main() async {
49 | WidgetsFlutterBinding.ensureInitialized();
50 | await Firebase.initializeApp();
51 | celest.init(
52 | externalAuth: ExternalAuth.firebase(FirebaseAuth.instance),
53 | );
54 | runApp(const MyApp());
55 | }
56 | ```
57 |
58 |
--------------------------------------------------------------------------------
/pages/docs/auth/supabase-auth.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Supabase Auth
3 | description: Learn how to use Supabase Auth for authenticating users in your Celest project.
4 | ---
5 |
6 | import { Callout } from 'nextra-theme-docs'
7 |
8 | # Supabase Auth
9 |
10 | If you're migrating to Celest from another framework, chances are you already have a user base that you'd like to use.
11 |
12 | As of Celest V1, Supabase can be used as your auth provider in Celest. And doing so is just as easy as with Celest's built-in auth.
13 |
14 | ## In your Celest project
15 |
16 | To use Supabase as your auth provider, add the following code to your `project.dart` file:
17 |
18 | ```dart copy filename="celest/lib/src/project.dart"
19 | import 'package:celest/celest.dart';
20 |
21 | const project = Project(name: 'supabase');
22 |
23 | const auth = Auth(
24 | providers: [
25 | ExternalAuthProvider.supabase(),
26 | ],
27 | );
28 | ```
29 |
30 | Verifying users with Supabase requires knowing your Supabase project's URL. When you run `celest start`, Celest will automatically search your environment for
31 | any available Supabase projects. If it can't figure out which project to use, you'll be prompted to enter it manually.
32 |
33 | Celest will securely store your Supabase project URL for future use so it doesn't need to prompt you again.
34 |
35 | ## In your Flutter app
36 |
37 | In your Flutter app, Celest will listen for changes to Supabase's auth state and update the Celest state accordingly so that
38 | calls to your Cloud Functions are authenticated appropriately.
39 |
40 | To do so, it needs access to your Supabase client, which you pass into the `celest.init` call in your `main` function.
41 |
42 | ```dart copy filename="lib/main.dart"
43 | import 'package:flutter/material.dart';
44 | import 'package:my_project_client/my_project_client.dart';
45 | import 'package:supabase_flutter/supabase_flutter.dart';
46 |
47 | Future<void> main() async {
48 | WidgetsFlutterBinding.ensureInitialized();
49 | final supabase = await Supabase.initialize(
50 | url: 'YOUR_SUPABASE_URL',
51 | anonKey: 'YOUR_SUPABASE_ANON_KEY',
52 | );
53 | celest.init(
54 | externalAuth: ExternalAuth.supabase(supabase.client.auth),
55 | );
56 | runApp(const MyApp());
57 | }
58 | ```
59 |
--------------------------------------------------------------------------------
/pages/docs/auth/using-the-auth-client.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Using the Flutter client
3 | description: Learn how to use the generated Flutter client to authenticate users in your app.
4 | ---
5 |
6 | ## Signing In
7 |
8 | To sign in a user, you can use the `authenticate` method on the `celest.auth` object. It's called `authenticate` because there is no longer a distinction between signing in or signing up!
9 | If the user doesn't exist, they will be created.
10 |
11 | ```dart
12 | final flow = await celest.auth.email.authenticate(
13 | email: 'dillon@celest.dev',
14 | );
15 |
16 | // Prompt user for OTP code sent to the email
17 |
18 | final user = await flow.verify(otpCode: '123456');
19 | print('User signed in: ${user.id}');
20 | ```
21 |
22 | A full example of a typical auth flow can be found in our [repo](https://github.com/celest-dev/celest/tree/main/packages/celest_auth/example).
23 |
24 | ## Listening for changes
25 |
26 | Celest provides a `Stream` interface to get notified when the state of the user changes. You should use this to update the UI when the user signs in or out and perform any other necessary actions.
27 |
28 | ```dart
29 | /// Shows the current user's information if they are signed in, automatically updating
30 | /// when the user signs in or out.
31 | class CurrentUser extends StatelessWidget {
32 | const CurrentUser({
33 | super.key,
34 | });
35 |
36 | @override
37 | Widget build(BuildContext context) {
38 | return StreamBuilder(
39 | stream: celest.auth.authStateChanges,
40 | builder: (context, snapshot) {
41 | if (snapshot.connectionState == ConnectionState.waiting) {
42 | return const CircularProgressIndicator();
43 | }
44 | final state = snapshot.data!;
45 | return switch (state) {
46 | Authenticated(:final user) => Text(
47 | 'Currently signed in: id=${user.userId}, '
48 | 'email=${user.primaryEmail?.email}',
49 | ),
50 | _ => const Text('Currently signed out'),
51 | };
52 | },
53 | );
54 | }
55 | }
56 | ```
57 |
58 | ## Authorizing your functions
59 |
60 | Once a user is signed in, they can access functions marked `@authenticated`. To learn more about authorizing your functions, check out [Authorizing functions](/docs/functions/authorizing-functions).
61 |
--------------------------------------------------------------------------------
/pages/docs/cli-commands-reference.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 4
3 | description: Learn more about Celest and how it helps you build the backend for your Flutter app.
4 | ---
5 |
6 | # CLI commands reference
7 |
8 | The following is a list of all the available commands from the Celest CLI. Visit our [downloads](/#download) page
9 | to install the Celest CLI on your computer.
10 |
11 | | Command | Description |
12 | | --------- | ------------------------------------------------------------- |
13 | | `celest init`| Creates a new Celest project |
14 | | `celest start`| Starts a local development environment |
15 | | `celest deploy` | Deploys your project to Celest Cloud |
16 | | `celest build` | Compiles and bundles your project for self-hosting |
17 | | `celest upgrade` | Upgrades the Celest CLI to the latest version. |
18 | | `celest uninstall`| Uninstall the Celest CLI and remove all associated data. |
19 | | `celest --help`| Show all available commands for the Celest CLI. |
20 | | `celest --version`| Show the current version of the Celest CLI. |
21 |
--------------------------------------------------------------------------------
/pages/docs/data.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Data
3 | description: Learn how to add a database to your Celest project.
4 | ---
5 |
6 | # Data
7 |
8 | Celest offers built-in database support thanks to the powerful combination of the [Drift](https://pub.dev/packages/drift) library
9 | and the [Turso](https://turso.tech/) platform.
10 |
11 | Drift is a Dart-native ORM that allows you to define your database schema in Dart code and generate the necessary
12 | SQL code to create and manage your database. Drift works best when it's backed by SQLite, and we think SQLite is a
13 | great choice of database for both frontend and backend environments alike.
14 |
15 | The only problem is that SQLite cannot scale beyond a single server which is why it's often scoffed at by enterprise developers.
16 | That's where Turso comes in. Turso is the company behind [libSQL](https://github.com/tursodatabase/libsql), an open-source fork of SQLite which builds on top
17 | of the SQLite codebase to provide a distributed, scalable, and secure database solution.
18 |
19 | Celest is proud to be the first Dart platform to offer Turso support out of the box, allowing you to build scalable and secure
20 | applications no matter the size of your user base.
21 |
22 | ## Getting Started
23 |
24 | To add a database to your Celest project, you need to define your database schema in Dart code. This is done using the Drift library.
25 |
26 | Here is an example database schema for a simple task management app:
27 |
28 | ```dart filename="celest/lib/src/database/task_database.dart"
29 | import 'package:drift/drift.dart';
30 |
31 | part 'task_database.g.dart';
32 |
33 | class Tasks extends Table {
34 | late final id = integer().autoIncrement()();
35 | late final title = text().withLength(min: 1, max: 100)();
36 | late final completed = boolean().withDefault(const Constant(false))();
37 | }
38 |
39 | @DriftDatabase(tables: [Tasks])
40 | class TaskDatabase extends _$TaskDatabase {
41 | TaskDatabase(super.e);
42 |
43 | @override
44 | int get schemaVersion => 1;
45 | }
46 | ```
47 |
48 | > For more guidance on writing Drift schemas, see the excellent documentation provided by the Drift author on their website: [Drift Documentation](https://drift.simonbinder.eu/docs/).
49 |
50 | Once you have a Drift schema, you're ready to add it to your Celest project. Navigate to your `project.dart` file and add the following code:
51 |
52 | ```dart {6-8} filename="celest/lib/src/project.dart"
53 | import 'package:celest/celest.dart';
54 | import 'package:celest_backend/src/database/task_database.dart';
55 |
56 | const project = Project(name: 'tasks');
57 |
58 | const taskDatabase = Database(
59 | schema: Schema.drift(TaskDatabase),
60 | );
61 | ```
62 |
63 | That's it! When you run `celest start`, Celest will automatically handle the database setup for you.
64 | You can now interact with your database using the generated `celest` global from your cloud functions.
65 |
66 | ```dart filename="celest/lib/src/functions/tasks.dart"
67 | import 'package:celest/celest.dart';
68 | import 'package:celest_backend/src/database/task_database.dart';
69 | import 'package:celest_backend/src/generated/cloud.celest.dart';
70 |
71 | TaskDatabase get db => celest.data.taskDatabase;
72 |
73 | @cloud
74 | Future<List<Task>> listAllTasks() async {
75 | print('Fetching tasks...');
76 | return db.select(db.tasks).get();
77 | }
78 | ```
79 |
--------------------------------------------------------------------------------
/pages/docs/download.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Download
3 | description: Download the Celest CLI and get started building your backend in Dart today.
4 | ---
5 |
6 | import { Callout } from 'nextra/components'
7 | import DownloadButton from '@components/DownloadButton'
8 |
9 | # Download Celest
10 |
11 | You can download the Celest CLI by running the following command:
12 |
13 | <div className="flex flex-col items-center space-y-4 my-4">
14 | <DownloadButton />
15 | </div>
16 |
17 | This will install the Celest CLI globally on your system, allowing you to use it from any directory.
18 |
19 | <Callout type="info">
20 | To ensure that the Celest CLI is available in your PATH, you may need to add the Dart SDK's pub cache to your PATH.
21 |
22 | On macOS and Linux, you can do this by adding the following line to your shell configuration file (e.g., `~/.bashrc`, `~/.zshrc`):
23 |
24 | ```bash
25 | export PATH="$PATH":"$HOME/.pub-cache/bin"
26 | ```
27 |
28 | On Windows, you can add the following location to your PATH environment variable:
29 |
30 | ```
31 | %LOCALAPPDATA%\Pub\Cache\bin
32 | ```
33 | </Callout>
34 |
--------------------------------------------------------------------------------
/pages/docs/folder-structure.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Folder structure
3 | description: The standard folder structure for defining the different parts of your Celest backend.
4 | ---
5 |
6 | # Folder structure
7 |
8 | Every Celest project uses a standard folder structure for defining the different parts of your backend.
9 |
10 | ```shell
11 | my_project/
12 | └── celest/
13 | ├── pubspec.yaml # (1) Dependencies for your backend
14 | │
15 | ├── client/ # (2) Generated Dart client
16 | │ ├── pubspec.yaml
17 | │ └── my_project_client.dart
18 | │
19 | └── lib/src/ # (3) Your backend code
20 | │── project.dart # (4) Project configuration
21 | └── functions/ # (5) Cloud functions
22 | └── orders_api.dart
23 | └── shipping_api.dart
24 | ```
25 |
26 | The folder structure should look very familiar. The `celest/` directory is just a Dart package, and the `lib/src/` directory is
27 | where you will define all of your backend logic. Of note:
28 |
29 | - (1) The `pubspec.yaml` file in the `celest/` directory is where you define your dependencies for your backend.
30 | These dependencies are separate from both your generated client's dependencies and your Flutter project's dependencies.
31 |
32 | - (2) The `client/` directory is where the Dart client is generated. This client is used to interact with your backend from your
33 | Dart or Flutter app. As the client is generated by the CLI, you should not modify it directly.
34 |
35 | - (3) The `lib/src/` directory is where you define your backend logic. This is where you will define your cloud functions,
36 | data models, and any other backend logic.
37 |
38 | - (4) The `project.dart` file is where you define your project configuration. This file is where you define your project name,
39 | and any other project-wide configuration. Any project-level configuration must be placed in this file.
40 |
41 | - (5) The `functions/` directory is where you define your cloud functions. Each file in this directory groups and organizes multiple
42 | Celest Functions of similar functionality into a namespace called an API.
43 |
44 | All of your Cloud Functions must be defined in the `lib/src/functions` folder for Celest to recognize them.
45 |
46 | Outside of the `project.dart` and `functions/` directories, you can create any other directories and files you need to organize your
47 | backend logic however you like.
48 |
--------------------------------------------------------------------------------
/pages/docs/functions.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Celest Functions
3 | description: Learn about use cases for Celest Functions.
4 | ---
5 |
6 | # Celest Functions
7 |
8 | Celest Functions are the primary Cloud Widget that enable you to run custom business logic in your backend. They run as serverless functions in the cloud, and are triggered by HTTP requests.
9 |
10 | ## Why would I want to use Celest Functions?
11 |
12 | Celest Functions enable you to:
13 | - Integrate your existing tools or data sources and serve that information to your app.
14 | - Create a separation layer between your business logic, and the UI of your app.
15 | - Add features to your backend without needing a new version deployed to the app stores.
16 |
17 | ## Next steps
18 |
19 | Follow our next guide to start building your first Celest Function!
20 |
--------------------------------------------------------------------------------
/pages/docs/functions/_meta.json:
--------------------------------------------------------------------------------
1 | {
2 | "--building": {
3 | "title": "Building",
4 | "type": "separator"
5 | },
6 | "creating-functions": "Creating a function",
7 | "data-types": "Defining your data types",
8 | "exceptions": "Throwing exceptions",
9 | "env-variables": "Configuring environment variables and secrets",
10 | "authorizing-functions": "Authorizing callers",
11 | "--iterating": {
12 | "title": "Iterating",
13 | "type": "separator"
14 | },
15 | "logging": "Logging and debugging",
16 | "testing": "Testing your functions",
17 | "packages": "Using packages",
18 | "--advanced": {
19 | "title": "Advanced",
20 | "type": "separator"
21 | },
22 | "customizing-serialization": "Customizing serialization",
23 | "http": {
24 | "display": "hidden"
25 | }
26 | }
--------------------------------------------------------------------------------
/pages/docs/functions/authorizing-functions.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Authorizing your functions
3 | description: Learn how to establish access control patterns for your Celest Functions.
4 | ---
5 |
6 | # Authorizing your functions
7 |
8 | By default, Celest Functions are deny-by-default, meaning only you as the author and administrator of your project can access them.
9 |
10 | To change the access level, you can use one of the following annotations:
11 |
12 | - `@public` — Grants access to anyone on the Internet, making your function publicly accessible.
13 | - `@authenticated` — Grants access to only authenticated users. (Requires an [auth provider](/docs/auth))
14 |
15 | When using Celest Auth, you have the ability to restrict access to your functions to only authenticated users. That is, those users
16 | who have signed up and are logged in.
17 |
18 | This is done by adding the `@authenticated` annotation to your function. When someone calls this function, either via the Celest client
19 | or directly via HTTP, Celest will check if the user is authenticated before allowing the function to run.
20 |
21 | ```dart {4} filename="celest/lib/src/functions/greeting.dart"
22 | import 'package:celest/celest.dart';
23 |
24 | @cloud
25 | @authenticated
26 | Future<String> sayHello() async {
27 | return 'Hello, valued customer!';
28 | }
29 | ```
30 |
31 | ### Public functions
32 |
33 | If you want to make a function public, you can use the `@public` annotation. This will all authorization middleware from the function
34 | and allow anyone on the Internet to call it.
35 |
36 | ```dart {4} filename="celest/lib/src/functions/greeting.dart"
37 | import 'package:celest/celest.dart';
38 |
39 | @cloud
40 | @public
41 | Future<String> sayHello() async {
42 | return 'Hello, world!';
43 | }
44 | ```
45 |
46 | ## Accessing user information
47 |
48 | To get the calling user's information, you can use the `@principal` annotation in your function and Celest will inject the caller's
49 | information automatically for each request.
50 |
51 | ```dart {6} filename="celest/lib/src/functions/greeting.dart"
52 | import 'package:celest/celest.dart';
53 |
54 | @cloud
55 | @authenticated
56 | Future<String> sayHello({
57 | @principal required User user,
58 | }) async {
59 | return 'Hello, ${user.displayName}!';
60 | }
61 | ```
62 |
63 | You can do this for `@public` functions as well since, in that case, there _may_ be a user that Celest knows about.
64 | For `@public` functions, the injected `User` parameter must be nullable to account for both scenarios.
65 |
66 | ```dart {6-7} filename="celest/lib/src/functions/greeting.dart"
67 | import 'package:celest/celest.dart';
68 |
69 | @cloud
70 | @public
71 | Future<String> sayHello({
72 | // User must be nullable here for `@public` functions
73 | @principal User? user,
74 | }) async {
75 | if (user == null) {
76 | return 'Hello, stranger!';
77 | }
78 | return 'Hello, ${user.displayName}!';
79 | }
80 | ```
--------------------------------------------------------------------------------
/pages/docs/functions/creating-functions.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Creating a function
3 | description: Learn how to create your first Celest cloud function.
4 | ---
5 |
6 | import { Callout } from 'nextra/components'
7 |
8 | # Creating a function
9 |
10 | Create serverless functions with Celest to connect different parts of your backend, and run custom business logic entirely in the cloud.
11 | You define cloud functions as regular Dart functions and Celest will automatically configure the HTTP endpoints, manage the serialization
12 | of Dart types to and from JSON and, when you're ready, deploy your functions to the cloud.
13 |
14 | ## Writing Celest Functions
15 |
16 | To write your first serverless cloud function, navigate to the `my_celest_app/celest/lib/src/functions/` folder and create a file named `<api_name>.dart`. You can create as many APIs as you want in this directory.
17 | Each file groups and organizes multiple Celest Functions of similar functionality into a namespace.
18 |
19 | Celest Functions are defined as top-level functions as shown below.
20 |
21 | <Callout type="info">
22 | Only functions annotated with `@cloud` are exposed as cloud functions. This prevents accidental deployment of functions and allows you to have shared logic and helper functions that are not exposed as cloud functions.
23 | </Callout>
24 |
25 | ```dart
26 | @cloud
27 | Future<String> sayHello(String name) async {
28 | return 'Hello, $name';
29 | }
30 |
31 | @cloud
32 | Future<String> sayGoodbye(String name) async {
33 | return 'Goodbye, $name';
34 | }
35 | ```
36 |
37 | That's all you need to define your API! Now, you can connect your Flutter app to your cloud functions by using the Celest client as shown in the following example. Replace the contents of the `main.dart` file in your Flutter app to the following code-snippet.
38 |
39 | ```dart {3,7,24}
40 | import 'package:flutter/material.dart';
41 | // Import the generated Celest client
42 | import 'package:my_project_client/my_project_client.dart';
43 |
44 | void main() {
45 | // Initialize Celest at the start of your app
46 | celest.init(environment: CelestEnvironment.local);
47 | runApp(const MyApp());
48 | }
49 |
50 | class MyApp extends StatelessWidget {
51 | const MyApp({super.key});
52 |
53 | @override
54 | Widget build(BuildContext context) {
55 | return MaterialApp(
56 | home: Scaffold(
57 | appBar: AppBar(
58 | title: const Text('Homepage'),
59 | ),
60 | body: Center(
61 | child: FutureBuilder(
62 | // Call your function using the Celest client
63 | future: celest.functions.greeting.sayHello('Celest'),
64 | builder: (_, snapshot) => switch (snapshot) {
65 | AsyncSnapshot(:final data?) => Text(data),
66 | AsyncSnapshot(:final error?) =>
67 | Text('${error.runtimeType}: $error'),
68 | _ => const CircularProgressIndicator(),
69 | },
70 | ),
71 | ),
72 | ),
73 | );
74 | }
75 | }
76 | ```
77 |
78 | ## Next steps
79 |
80 | You now know how to create Celest Functions and connect them to your Flutter app. We have other guides to help explain how to use features such as [logging](/docs/functions/logging.md), [using custom data types](/docs/functions/data-types.md), and [managing environment variables](/docs/functions/env-variables.md).
81 |
--------------------------------------------------------------------------------
/pages/docs/functions/customizing-serialization.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Customizing serialization
3 | description: Learn how to customize serialization logic for your Celest Functions.
4 | ---
5 |
6 | import { Callout } from 'nextra/components'
7 |
8 | # Customizing serialization
9 |
10 | If you need custom handling for your serialization logic, either to conform to an existing interface or to ensure parity with other parts
11 | of your application, define the `fromJson` and `toJson` methods to your data type. Celest will use these methods when provided instead of
12 | its default serialization logic.
13 |
14 | ## Example
15 |
16 | Consider the `Price` type that we defined in [Defining your data types](./data-types.mdx).
17 |
18 | ```dart
19 | enum Currency { usd, cad, ... }
20 |
21 | class Price {
22 | const Price({
23 | required this.currency,
24 | required this.dollars,
25 | required this.cents,
26 | }): assert(cents < 100);
27 |
28 | final Currency currency;
29 | final int dollars;
30 | final int cents;
31 | }
32 | ```
33 |
34 | By default, Celest follows the conventions of `package:json_serializable` and will serialize the `Price` type as:
35 |
36 | ```json
37 | {
38 | "currency": "usd",
39 | "dollars": 100,
40 | "cents": 34
41 | }
42 | ```
43 |
44 | If, however, you want to serialize the `currency` field as uppercase, you can define the `fromJson` and `toJson` methods
45 | in the `Price` class.
46 |
47 | ```dart {6-8,15} filename="celest/lib/src/models/price.dart"
48 | class Price {
49 | // ...
50 |
51 | factory Price.fromJson(Map<String, dynamic> json) {
52 | return Price(
53 | currency: Currency.values.firstWhere(
54 | (e) => e.toString().toUpperCase() == json['currency'],
55 | ),
56 | dollars: json['dollars'] as int,
57 | cents: json['cents'] as int,
58 | );
59 | }
60 |
61 | Map<String, dynamic> toJson() => {
62 | 'currency': currency.name.toUpperCase(),
63 | 'dollars': dollars,
64 | 'cents': cents,
65 | };
66 | }
67 | ```
68 |
69 | Then, anytime you use the `Price` type in a cloud function, Celest will use this logic for handling
70 | the serialization. And the resulting JSON response for the `currency` will be properly upper-cased.
71 |
72 | ```diff {6,7}
73 | {
74 | "customerOrder": {
75 | "id": 123,
76 | "customerName": "Celest",
77 | "price": {
78 | + "currency": "USD",
79 | - "currency": "usd",
80 | "dollars": 100,
81 | "cents": 34
82 | }
83 | }
84 | }
85 | ```
86 |
87 | ## Customize serialization of third-party types [#custom-overrides]
88 |
89 | Sometimes, though, you cannot control the `fromJson`/`toJson` methods of a class, such as when using a third-party library.
90 | In these cases, you can create a `@customOverride` which "redefines" the type for serialization in Celest.
91 |
92 | For example, consider the case where the `Price` class from our `Order` type is imported from a third-party library, `package:price`.
93 | Since we do not own `package:price`, we cannot change the `fromJson` and `toJson` methods of the `Price` class.
94 |
95 | Instead of modifying the `Price` class, we can define a custom override for `Price` which will be used in place of the original
96 | `Price` class when it's encountered in Celest.
97 |
98 | <Callout>
99 | Custom overrides are defined as [extension types](https://dart.dev/language/extension-types) which wrap and implement the original type.
100 | You can use these to override any part of the original interface to suit its use in your backend, though customizing serialization is the
101 | most common use case.
102 |
103 | You must always **implement** the original type in your extension type and mark it with `@customOverride`. By convention, these types are
104 | defined in either `lib/models/_overrides.dart` or `lib/exceptions/_overrides.dart` and are not used directly in your backend. They serve as
105 | global marker types which Celest will use internally.
106 | </Callout>
107 |
108 | ```dart {10-11} filename="celest/lib/src/models/_overrides.dart"
109 | import 'package:celest/celest.dart';
110 | import 'package:price/price.dart';
111 |
112 | // We create an extension type which wraps over the third-party type and
113 | // is marked as a custom override of it.
114 | //
115 | // You do not need to use this type directly in your backend. Celest will
116 | // use it internally anytime it encounters the original type.
117 | @customOverride
118 | extension type PriceOverride(Price price) implements Price {
119 | factory PriceOverride.fromJson(Map<String, Object?> json) {
120 | return PriceOverride(
121 | Price(
122 | currency: Currency.values.firstWhere(
123 | (e) => e.toString().toUpperCase() == json['currency'],
124 | ),
125 | dollars: json['dollars'] as int,
126 | cents: json['cents'] as int,
127 | ),
128 | );
129 | }
130 |
131 | Map<String, Object?> toJson() => {
132 | 'currency': price.currency.toString().toUpperCase(),
133 | 'dollars': price.dollars,
134 | 'cents': price.cents,
135 | };
136 | }
137 | ```
138 |
139 | ## Next steps
140 |
141 | You have now learned how Celest handles the serialization of requests/responses to your functions, and how to use your own custom types and serialization logic. Learn about more features of Celest Functions by following our guides for [defining custom exceptions](/docs/functions/exceptions.md) and [managing environment variables](/docs/functions/env-variables.md).
142 |
--------------------------------------------------------------------------------
/pages/docs/functions/data-types.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Defining your data types
3 | description: Learn how to define data types which can be passed to and from your Celest Functions.
4 | ---
5 |
6 | import { Callout } from 'nextra/components'
7 |
8 | # Defining your data types
9 |
10 | With Celest Functions, you can use any of the core Dart types available such as `int`, `String`, and `DateTime`.
11 | You can also use your own data types. Celest will automatically handle the transfer of data to and from your Flutter app
12 | (a process known as serialization) so you don't need to think about it.
13 |
14 | > If you'd prefer to handle the serialization yourself, Celest will use your [custom logic](./customizing-serialization.mdx) instead.
15 |
16 | Imagine you're working on an e-commerce application with an `Order` class defined in your codebase.
17 |
18 | ```dart filename="celest/lib/src/models/order.dart"
19 | class Order {
20 | const Order ({
21 | required this.id,
22 | required this.customerName,
23 | required this.price,
24 | });
25 |
26 | final int id;
27 | final String customerName;
28 | final Price price;
29 | }
30 |
31 | enum Currency { usd, cad, ... }
32 |
33 | class Price {
34 | const Price({
35 | required this.currency,
36 | required this.dollars,
37 | required this.cents,
38 | }): assert(cents < 100);
39 |
40 | final Currency currency;
41 | final int dollars;
42 | final int cents;
43 | }
44 | ```
45 |
46 | When you pass this `Order` type as a parameter to a cloud function or when you return it from a cloud function,
47 | Celest will automatically serialize and deserialize it for you.
48 |
49 | ```dart {1,5} filename="celest/lib/src/functions/orders.dart"
50 | import 'package:celest_backend/models/order.dart';
51 |
52 | @cloud
53 | Future<String> createOrder(
54 | Order customerOrder,
55 | ) async {
56 | // Function logic goes here
57 | }
58 | ```
59 |
60 | Celest does this by inspecting every function marked with `@cloud` to find the data types you've used and any types those types use
61 | and generates a schema for each of them. This schema is then used to serialize and deserialize the data to and from JSON.
62 |
63 | For example when passing an order to your backend, Celest will serialize the `Order` class as a JSON map with the field names as keys and
64 | the values marshalled to the appropriate JSON representation.
65 |
66 | ```json
67 | {
68 | "customerOrder": {
69 | "id": 123,
70 | "customerName": "Celest",
71 | "price": {
72 | "currency": "usd",
73 | "dollars": 100,
74 | "cents": 34
75 | }
76 | }
77 | }
78 | ```
79 |
80 | Similarly if your Flutter app receives an `Order` object from a Celest Function, Celest knows how to take this JSON and map it back into
81 | the same Dart type. The process happens so transparently that you'll feel like you're just passing Dart objects directly between two
82 | local functions.
83 |
84 | ## Next steps
85 |
86 | Read on to see how you can seamlessly catch errors thrown from your backend in your Flutter app and how to configure the environment
87 | in which your backend runs.
88 |
--------------------------------------------------------------------------------
/pages/docs/functions/env-variables.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Configuring environment variables and secrets
3 | description: Learn how to create and manage environment variables and secrets that your Celest Functions can access.
4 | ---
5 |
6 | import { Callout } from 'nextra/components'
7 |
8 | # Configuring environment variables and secrets
9 |
10 | Both environment variables and secrets can be used to provide your Celest backend with environment-specific configuration.
11 | They allow you to keep configuration values separate from your codebase, improving flexibility when deploying your backend
12 | to different environments and isolating sensitive information from your frontend.
13 |
14 | Because of this, it's important to keep in mind that environment variables and secrets are not accessible from your frontend code.
15 |
16 | ## Creating environment variables
17 |
18 | To declare an environment variable, add a Dart variable in your `project.dart` file using the `env` constructor.
19 |
20 | ```dart filename="celest/lib/src/project.dart"
21 | import 'package:celest/celest.dart';
22 |
23 | const project = Project(name: 'my-project');
24 |
25 | const myEnv = env('MY_ENV');
26 | ```
27 |
28 | The name passed to `env` is the name as it appears in the platform environment. This name will be used to configure your Celest Functions when
29 | they're deployed to Celest Cloud or when self hosting in a container.
30 |
31 | Celest keeps track of the unique variables throughout your project and ensures that any missing values are provided before you deploy your project.
32 | When you run `celest start` for the first time, it will prompt you for the value of each environment variable. After you provide the values, Celest
33 | will securely store them for future use.
34 |
35 | ### Using `.env` files
36 |
37 | You can also use a `.env` file to store your environment variables. This file should be placed in the root of your project directory in the `celest/`
38 | folder. When a `.env` file is present, Celest will start by reading the values from the file and only then prompt you for any missing values.
39 |
40 | When the values of these variables changes between environments, you can suffix your `.env` files with the name of the environment they apply to.
41 | For example, Celest currently provides a `local` and `production` environment. Given the following `.env` files:
42 |
43 | ```plaintext
44 | my-project/
45 | celest/
46 | .env.local
47 | .env.production
48 | pubspec.yaml
49 | ```
50 |
51 | ```plaintext filename=".env.local"
52 | MY_ENV=local-value
53 | ```
54 |
55 | ```plaintext filename=".env.production"
56 | MY_ENV=production-value
57 | ```
58 |
59 | The value of `MY_ENV` will be `local-value` when you run `celest start`, and `production-value` you run `celest deploy` or `celest build`.
60 |
61 | ## Using environment variables with Celest Functions
62 |
63 | To get the value of an environment variable in a Celest Function, you can use the generated `celest` global. Just like in your Flutter app,
64 | Celest will generated some helper methods to access important parts of your project.
65 |
66 | In this case, we can use `celest.variables.myEnv` to access the value of the `MY_ENV` environment variable.
67 |
68 | ```dart {6} filename="celest/lib/src/functions/greeting.dart"
69 | // Import the generated `celest` global
70 | import 'package:celest_backend/src/generated/cloud.celest.dart';
71 |
72 | @cloud
73 | Future<String> sayHello(String name) async {
74 | print('My environment variable is ${celest.variables.myEnv}');
75 | return 'Hello, $name!';
76 | }
77 | ```
78 |
79 | When the `sayHello` function runs, it will automatically have access to the environment variable. Its value is stored securely and is never
80 | hard-coded in your codebase or in the deployed Celest Function.
81 |
82 | ## Creating secrets
83 |
84 | Secrets are created and managed exactly like environment variables. The only difference is that secrets are encrypted by Celest and are not
85 | displayed in the console when you run `celest start`. Otherwise, how you use them in your code is the same as environment variables.
86 |
87 | To create a secret, use the `secret` constructor instead of `env`.
88 |
89 | ```dart {6} filename="celest/lib/src/project.dart"
90 | import 'package:celest/celest.dart';
91 |
92 | const project = Project(name: 'my-project');
93 |
94 | const myEnv = env('MY_ENV');
95 | const mySecret = secret('MY_SECRET');
96 | ```
97 |
98 | Then, you can use the `celest.secrets` helper in your functions in the same way as environment variables.
99 |
100 | ```dart {7} filename="celest/lib/src/functions/greeting.dart"
101 | // Import the generated `celest` global
102 | import 'package:celest_backend/src/generated/cloud.celest.dart';
103 |
104 | @cloud
105 | Future<String> sayHello(String name) async {
106 | print('My environment variable is ${celest.variables.myEnv}');
107 | print('My secret is ${celest.secrets.mySecret}');
108 | return 'Hello, $name!';
109 | }
110 | ```
111 |
112 | ## Next steps
113 |
114 | You have now learned about the flows available for updating, retreiving, and deleting environment variables in your Celest project. You can follow additional guides to learn more about [testing your functions](/docs/functions/testing.md), and [installing 3rd party Dart packages](/docs/functions/packages.md).
115 |
--------------------------------------------------------------------------------
/pages/docs/functions/exceptions.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Throwing exceptions
3 | description: Learn how Celest handles thrown exceptions on your backend and how to catch them in your Flutter app.
4 | ---
5 |
6 | import { Callout } from 'nextra/components'
7 |
8 | # Throwing exceptions
9 |
10 | Celest also knows how to handle exceptions thrown in your Celest Functions. When an exception is thrown, Celest will do three things:
11 |
12 | - Catch the thrown exception serialize it using the same process outlined above
13 | - Map the exception to an appropriate HTTP response and status code
14 | - Deserialize the exception type in your Flutter app and rethrow the same Dart type with the original message
15 |
16 | Suppose you have some validation logic on your server which checks that a user's name is properly formatted. If the name is empty,
17 | you want to throw an exception. You can define a Dart type in your Celest backend to represent this error.
18 |
19 | ```dart filename="celest/lib/src/exceptions/bad_name_exception.dart"
20 | class BadNameException implements Exception {
21 | const BadNameException(this.message);
22 |
23 | final String message;
24 | }
25 | ```
26 |
27 | When you encounter an empty name, you can throw this exception in your Celest Function.
28 |
29 | ```dart {7} filename="celest/lib/src/functions/greeting.dart"
30 | import 'package:celest_backend/exceptions/bad_name_exception.dart';
31 |
32 | @cloud
33 | Future<String> sayHello(String name) async {
34 | // Perform custom validation
35 | if (name.isEmpty) {
36 | throw const BadNameException('Name cannot be empty');
37 | }
38 | return 'Hello, $name';
39 | }
40 | ```
41 |
42 | In your Flutter app, the same `BadNameException` type will be thrown by the generated client so
43 | you can catch it and handle it as you would any other exception. Any `message` you passed in the
44 | on the server will be available in the `message` field of the exception on the client. Magically!
45 |
46 | ```dart {8-11}
47 | import 'package:my_project_client/my_project_client.dart';
48 |
49 | @cloud
50 | Future<String> getGreeting(String name) async {
51 | try {
52 | return await celest.functions.greeting.sayHello(name);
53 | // Catch the exception type defined in your backend
54 | } on BadNameException catch (e) {
55 | print(e.message); // prints "Name cannot be empty"
56 | rethrow;
57 | }
58 | }
59 | ```
60 |
61 | ## HTTP mapping
62 |
63 | When an exception is thrown in your Celest Function, Celest will map the exception to an appropriate HTTP response code.
64 | For example, all `Exception` types will be mapped to a `400 Bad Request` status and all `Error` types will be mapped
65 | to a `500 Internal Server Error` status by default.
66 |
67 | Celest also provides a number of built-in exception types for common HTTP status codes. For example, you can throw a `NotFoundException`
68 | to return a `404 Not Found` status code. And you can even include a custom message with it.
69 |
70 | ```dart
71 | import 'package:celest/celest.dart';
72 |
73 | @cloud
74 | Future<String> sayHello(String name) async {
75 | if (name.isEmpty) {
76 | throw const NotFoundException('Name cannot be empty');
77 | }
78 | return 'Hello, $name';
79 | }
80 | ```
81 |
82 | If an exception type you've defined needs to be mapped to a different status code, you can use the `@httpError` annotation to
83 | specify the status code Celest should use for it. For example, maybe we want our `BadNameException` to return a `404 Not Found` status
84 | instead of the default `400`.
85 |
86 | ```dart
87 | import 'package:celest/celest.dart';
88 | import 'package:celest/http.dart';
89 |
90 | class BadNameException implements Exception {
91 | const BadNameException(this.message);
92 |
93 | final String message;
94 | }
95 |
96 | @cloud
97 | @httpError(404, BadNameException)
98 | Future<String> sayHello(String name) async {
99 | if (name.isEmpty) {
100 | throw const BadNameException('Name cannot be empty');
101 | }
102 | return 'Hello, $name';
103 | }
104 | ```
105 |
106 | ## Next steps
107 |
108 | You have now learned how to handle exceptions in your Celest Functions. Keep reading to learn about [configuring your environment](./env-variables.mdx)
109 | and [ensuring your backend is secure](./authorizing-functions.mdx).
110 |
--------------------------------------------------------------------------------
/pages/docs/functions/http.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Standard HTTP conventions
3 | description: Learn how your Celest Functions can be called using normal HTTP requests.
4 | ---
5 |
6 | # Using HTTP calls
7 |
8 | If you'd like to use your Celest Functions outside of your Flutter app, you still can! Celest Functions are exposed as HTTP endpoints which can be called via any HTTP client from any programming language or toolchain.
9 |
10 | ## Celest's HTTP conventions
11 |
12 | When communicating with Celest Functions using HTTP calls, all requests need to be sent as `POST` calls. Additionally, Celest handle all request/responses as JSON objects.
13 |
14 | The following is a list of the HTTP response code conventions used by Celest.
15 |
16 |
17 | | Response Code | Description |
18 | | --------- | ------------------------------------------------------------- |
19 | | `200` | Indicates a call was successful |
20 | | `400` | Indicates an Exception was thrown |
21 | | `500` | Indicates an Error was thrown |
22 |
23 | ## Error formats
24 |
25 | When a function fails with an exception or error, the HTTP response will carry a 4xx/5xx status code and JSON body with an `error` key. If the exception is a user-defined exception type, the `error` field itself is encoded as a JSON message.
26 |
27 | For example, let us assume you have a custom exception called `BadNameException` type defined in the example below.
28 |
29 | ```dart filename="celest/lib/src/exceptions/bad_name_exception.dart"
30 | class BadNameException implements Exception {
31 | const BadNameException(this.message);
32 |
33 | final String message;
34 | }
35 | ```
36 |
37 |
38 | If this exception is returned in one of your Celest Functions that you are calling with an HTTP request, the resulting JSON response will be as shown below.
39 |
40 | ```http
41 | HTTP/1.1 400 Bad Request
42 | Content-Type: application/json
43 |
44 | {
45 | "error": {
46 | "code": "BadNameException",
47 | "details": {
48 | "message": "Input cannot be empty"
49 | }
50 | }
51 | }
52 | ```
53 |
54 | However, if the function threw a `StateError`, it would look like this. For non-custom exceptions, the "details" field is omitted. This is done in order to prevent leaking information which may be sensitive to your application. Define custom exceptions to provide more information to your users as appropriate.
55 |
56 | ```http
57 | HTTP/1.1 500 Internal Server Error
58 | Content-Type: application/json
59 |
60 | {
61 | "error": {
62 | "code": "StateError"
63 | }
64 | }
65 | ```
66 |
67 | ## Next steps
68 |
69 | You have now learned about the conventions that Celest uses when passing data between your backend and your Flutter application, in addition to the format of the request/response and the HTTP response codes supported. With this knowledge, you now know how to connect to your Celest Functions directly using HTTP calls if you are not using a Flutter app.
70 |
--------------------------------------------------------------------------------
/pages/docs/functions/http/_meta.json:
--------------------------------------------------------------------------------
1 | {
2 | "conventions": "Calling convention",
3 | "customization": "Customization"
4 | }
--------------------------------------------------------------------------------
/pages/docs/functions/http/conventions.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Standard HTTP conventions
3 | description: Learn how your Celest Functions can be called using normal HTTP requests.
4 | ---
5 |
6 | # Using HTTP calls
7 |
8 | If you'd like to use your Celest Functions outside of your Flutter app, you still can! Celest Functions are exposed as HTTP endpoints which can be called via any HTTP client from any programming language or toolchain.
9 |
10 | ## Celest's HTTP conventions
11 |
12 | When communicating with Celest Functions using HTTP calls, all requests need to be sent as `POST` calls. Additionally, Celest handle all request/responses as JSON objects.
13 |
14 | The following is a list of the HTTP response code conventions used by Celest.
15 |
16 |
17 | | Response Code | Description |
18 | | --------- | ------------------------------------------------------------- |
19 | | `200` | Indicates a call was successful |
20 | | `400` | Indicates an Exception was thrown |
21 | | `500` | Indicates an Error was thrown |
22 |
23 | ## Error formats
24 |
25 | When a function fails with an exception or error, the HTTP response will carry a 4xx/5xx status code and JSON body with an `error` key. If the exception is a user-defined exception type, the `error` field itself is encoded as a JSON message.
26 |
27 | For example, let us assume you have a custom exception called `BadNameException` type defined in the example below.
28 |
29 | ```dart
30 | // celest/lib/exceptions/bad_name_exception.dart
31 |
32 | class BadNameException implements Exception {
33 | const BadNameException(this.message);
34 |
35 | final String message;
36 | }
37 | ```
38 |
39 |
40 | If this exception is returned in one of your Celest Functions that you are calling with an HTTP request, the resulting JSON response will be as shown below.
41 |
42 | ```http
43 | HTTP/1.1 400 Bad Request
44 | Content-Type: application/json
45 |
46 | {
47 | "error": {
48 | "code": "BadNameException",
49 | "details": {
50 | "message": "Input cannot be empty"
51 | }
52 | }
53 | }
54 | ```
55 |
56 | However, if the function threw a `StateError`, it would look like this. For non-custom exceptions, the "details" field is omitted. This is done in order to prevent leaking information which may be sensitive to your application. Define custom exceptions to provide more information to your users as appropriate.
57 |
58 | ```http
59 | HTTP/1.1 500 Internal Server Error
60 | Content-Type: application/json
61 |
62 | {
63 | "error": {
64 | "code": "StateError"
65 | }
66 | }
67 | ```
68 |
69 | ## Next steps
70 |
71 | You have now learned about the conventions that Celest uses when passing data between your backend and your Flutter application, in addition to the format of the request/response and the HTTP response codes supported. With this knowledge, you now know how to connect to your Celest Functions directly using HTTP calls if you are not using a Flutter app.
72 |
--------------------------------------------------------------------------------
/pages/docs/functions/http/customization.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: HTTP Customization
3 | description: Learn how to control and customize the HTTP API generated for your Celest Functions.
4 | ---
5 |
6 | import { Callout } from 'nextra-theme-docs'
7 |
8 | # HTTP Customization
9 |
10 | In cases where Celest's standard HTTP conventions do not align with your requirements, you can control the HTTP API generated for your Celest Functions using the HTTP annotations.
11 |
12 | <Callout type="info">
13 | Some HTTP elements are not currently configurable, such as the URL path. If you require this functionality, please let us know by creating an [issue](https://github.com/celest-dev/celest/issues/new/choose).
14 | </Callout>
15 |
16 | ## Execution Controls
17 |
18 | The `@http` and `@httpError` annotations allow you to control the behavior of the HTTP endpoint, such as how the endpoint is exposed,
19 | and how it responds in both success and error cases.
20 |
21 | ### `@http`
22 |
23 | To configure the method and default status code of your HTTP endpoint, use the `@http` annotation.
24 |
25 | ```dart
26 | @cloud
27 | @http(
28 | method: HttpMethod.put,
29 | statusCode: HttpStatus.created,
30 | )
31 | Future<String> greet(String name) async {
32 | return 'Hello, $name';
33 | }
34 | ```
35 |
36 | <div className="grid grid-cols-2 gap-4">
37 | <div>
38 | ```http
39 | PUT /greet
40 | Content-Type: application/json
41 |
42 | {
43 | "name": "Celest"
44 | }
45 | ```
46 | </div>
47 | <div>
48 | ```http
49 | HTTP/1.1 201 Created
50 | Content-Type: application/json
51 |
52 | {
53 | "response": "Hello, Celest"
54 | }
55 | ```
56 | </div>
57 | </div>
58 |
59 | ### `@httpError`
60 |
61 | To control the status code returned from one or more thrown types, use the `@httpError` annotation.
62 |
63 | ```dart
64 | @cloud
65 | @httpError(403, UnauthorizedException)
66 | @httpError(404, BadNameException, NotFoundException)
67 | Future<String> greet(String name) async {
68 | if (name.isEmpty) {
69 | throw BadNameException();
70 | }
71 | if (!name.startsWith('C')) {
72 | throw NotFoundException();
73 | }
74 | if (name != 'Celest') {
75 | throw UnauthorizedException();
76 | }
77 | return 'Hello, $name';
78 | }
79 | ```
80 |
81 | <Callout type="info">
82 | Exception types are handled in order of specificity. Specifying a type that other types inherit from will only apply the status code
83 | to subtypes which are not already covered by a more specific case.
84 |
85 | For example, the following will return a 404 status code for both the concrete `NotFoundException` type and `BadNameException` (since it
86 | is a subtype of `Exception`), but not `UnauthorizedException` which is covered by a more specific annotation.
87 |
88 | ```dart
89 | @cloud
90 | @httpError(404, NotFoundException, Exception)
91 | @httpError(403, UnauthorizedException)
92 | Future<String> greet(String name) async {
93 | if (name.isEmpty) {
94 | throw BadNameException(); // 404
95 | }
96 | if (!name.startsWith('C')) {
97 | throw NotFoundException(); // 404
98 | }
99 | if (name != 'Celest') {
100 | throw UnauthorizedException(); // 403
101 | }
102 | return 'Hello, $name';
103 | }
104 | ```
105 | </Callout>
106 |
107 | ## Request Controls
108 |
109 | The `@httpHeader` and `@httpQuery` annotations allow you to map input parameters to HTTP headers and query parameters, respectively.
110 | Any parameters which are not targeted by these annotations are passed as the request body.
111 |
112 | <Callout>
113 | Some combinations are disallowed. For example, if the `@http` annotation specifies a `GET` method, then all input
114 | parameters **must** be mapped, or there must be no input parameters, such that the request body is empty.
115 | </Callout>
116 |
117 | ### `@httpHeader`
118 |
119 | To map an input parameter to an HTTP header, use the `@httpHeader` annotation.
120 |
121 | <Callout type="info">
122 | Only parameters of type `String`, `int`, `double`, `bool`, `DateTime`, or a `List` of these types, can be targeted by `@httpHeader`.
123 | </Callout>
124 |
125 | ```dart
126 | @cloud
127 | Future<String> greet({
128 | @httpHeader('x-api-key') required String apiKey,
129 | required String name,
130 | }) async {
131 | return 'Hello, $name';
132 | }
133 | ```
134 |
135 | In the generated client, these parameters are passed transparently as function arguments.
136 |
137 | ```dart
138 | final result = await celest.functions.greet(apiKey: '123', name: 'Celest');
139 | ```
140 |
141 | <div className="grid grid-cols-2 gap-4">
142 | <div>
143 | ```http
144 | POST /greet
145 | Content-Type: application/json
146 | x-api-key: 123
147 |
148 | {
149 | "name": "Celest"
150 | }
151 | ```
152 | </div>
153 | <div>
154 | ```http
155 | HTTP/1.1 200 OK
156 | Content-Type: application/json
157 |
158 | {
159 | "response": "Hello, Celest"
160 | }
161 | ```
162 | </div>
163 | </div>
164 |
165 | The following HTTP headers are reserved and cannot be targeted by `@httpHeader`:
166 |
167 | <div className="flex flex-row items-start justify-center mt-4">
168 | <div className="self-end">
169 | | Header Name |
170 | | ----------- |
171 | | `Connection` |
172 | | `Content-Length` |
173 | | `Expect` |
174 | | `Host` |
175 | | `Max-Forwards` |
176 | | `Server` |
177 | | `TE` |
178 | </div>
179 |
180 | <div>
181 | | Header Name |
182 | | ----------- |
183 | | `Trailer` |
184 | | `Transfer-Encoding` |
185 | | `Upgrade` |
186 | | `User-Agent` |
187 | | `Via` |
188 | | `X-Forwarded-For` |
189 | </div>
190 | </div>
191 |
192 | ### `@httpQuery`
193 |
194 | To map an input parameter to a query parameter, use the `@httpQuery` annotation.
195 |
196 | <Callout type="info">
197 | Only parameters of type `String`, `int`, `double`, `bool`, `DateTime`, or a `List` of these types, can be targeted by `@httpQuery`.
198 | </Callout>
199 |
200 | ```dart
201 | @cloud
202 | @http(method: HttpMethod.get)
203 | Future<String> greet({
204 | @httpQuery('name') required String name,
205 | }) async {
206 | return 'Hello, $name';
207 | }
208 | ```
209 |
210 | In the generated client, these parameters are passed transparently as function arguments.
211 |
212 | ```dart
213 | final result = await celest.functions.greet(name: 'Celest');
214 | ```
215 |
216 | <div className="grid grid-cols-2 gap-4">
217 | <div>
218 | ```http
219 | GET /greet?name=Celest
220 | Accept: application/json
221 | ```
222 | </div>
223 | <div>
224 | ```http
225 | HTTP/1.1 200 OK
226 | Content-Type: application/json
227 |
228 | {
229 | "response": "Hello, Celest"
230 | }
231 | ```
232 | </div>
233 | </div>
--------------------------------------------------------------------------------
/pages/docs/functions/img/file-middleware.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/pages/docs/functions/img/file-middleware.png
--------------------------------------------------------------------------------
/pages/docs/functions/img/function.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/pages/docs/functions/img/function.png
--------------------------------------------------------------------------------
/pages/docs/functions/img/individual-middleware.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/pages/docs/functions/img/individual-middleware.png
--------------------------------------------------------------------------------
/pages/docs/functions/logging.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Logging and debugging
3 | description: Learn how to use logging for debugging your Celest Functions.
4 | ---
5 |
6 | # Logging and debugging
7 |
8 | Celest enables you to use logging to capture helpful information about your functions while they execute. Within your function code, use `print()` statements or a custom logger package which prints to the conosole. These logs will appear in the same console where the `celest start` command is running.
9 |
10 | ## Adding logs to your functions
11 |
12 | Here is an example of using print statements to log the input of `name` in a Celest Function.
13 |
14 | ```dart {3,9} filename="celest/lib/src/functions/greeting.dart"
15 | @cloud
16 | Future<String> sayHello(String name) async {
17 | print('Saying hello to $name');
18 | return 'Hello, $name';
19 | }
20 |
21 | @cloud
22 | Future<String> sayGoodbye(String name) async {
23 | print('Saying goodbye to $name');
24 | return 'Goodbye, $name';
25 | }
26 | ```
27 |
28 | When you call the function, these logs will be streamed locally and shown in the terminal where the `celest start` command is running.
29 |
30 | ```shell
31 | $ celest start
32 | ✓ Celest is running on http://localhost:7777
33 |
34 | [greeting/sayHello] Saying hello to Celest
35 | [greeting/sayGoodbye] Saying goodbye to Celest
36 | ```
37 |
38 | ## Next steps
39 |
40 | You have now learned how to use Logging to help you understand how your Celest Functions are behaving, or debug specific scenarios or flows. Follow our guides to learn about [testing your functions](/docs/functions/testing.md) and [using 3rd party Dart packages](/docs/functions/packages.md).
41 |
--------------------------------------------------------------------------------
/pages/docs/functions/packages.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Using packages
3 | description: Learn how to integrate existing Dart packages into your Celest backend.
4 | ---
5 |
6 | # Using packages
7 |
8 | Your Celest backend is a pure Dart application. Any Dart packages which can be used in a Dart app can be used in your functions. For example, to communicate with systems outside of Celest, you could use `package:http`, `package:dio`, or any other HTTP client compatible with pure Dart.
9 |
10 | ## Adding a Dart package to your backend
11 |
12 | To add a package for use in your backend, navigate in your terminal to the `<flutter_app>/celest` folder and then run the `dart pub add <package-name>` command.
13 |
14 | ```shell
15 | $ dart pub add <package-name>
16 | ```
17 |
18 | ## Next steps
19 |
20 | You have now learned how to install packages in your Celest backend. Keep reading to learn about more advanced topics
21 | like [customizing serialization](./customizing-serialization.mdx) or check out our guides on [Auth](/docs/auth) and [Data](/docs/data).
22 |
23 |
--------------------------------------------------------------------------------
/pages/docs/functions/testing.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Testing your functions
3 | description: Learn how to test your Celest Functions.
4 | ---
5 |
6 | # Testing your functions
7 |
8 | Celest Functions you define are Dart functions and can be tested using any of the available Dart testing packages or frameworks.
9 |
10 | ## Writing your tests
11 |
12 | Within your `celest/test` folder, create a new Dart file and write the unit tests for your functions using `package:test` or any other Dart testing framework. The following code snippet has an example of a test for the `sayHello` function.
13 |
14 | ```dart
15 | import 'package:celest/celest.dart';
16 | import 'package:celest_backend/src//functions/greeting.dart';
17 | import 'package:test/test.dart';
18 |
19 | void main() {
20 | test('sayHello', () async {
21 | final result = await sayHello(
22 | name: 'Celest',
23 | greetingUrl: Uri.parse('http://localhost:8000'),
24 | );
25 | expect(result, 'Hello, Celest');
26 | });
27 | }
28 | ```
29 |
30 | Run your tests by navigating to your `celest/` folder in your console, and then running the following command:
31 |
32 | ```shell
33 | dart test
34 | ```
35 |
36 | Your terminal will let you know if all your tests pass, or if there are any failed tests that you need to review.
37 |
38 | ## Next steps
39 |
40 | You have now learned how to write tests for your Celest Functions. Keep reading to learn how to start
41 | [adding other packages](./packages.mdx) in your Celest backend.
42 |
--------------------------------------------------------------------------------
/pages/docs/get-started.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Getting started
3 | description: Learn how to set up and use Celest in your Flutter project.
4 | ---
5 |
6 | import { Cards, Card } from 'nextra/components';
7 | import { FunctionsIcon, AuthIcon, DataIcon } from '@components/icons';
8 | import DownloadButton from '@components/DownloadButton';
9 |
10 | # Getting started
11 |
12 | This guide walks you through setting up Celest on your development machine, and how to create a new project.
13 |
14 | To get started with Celest, you'll need to configure your development environment so that you have Flutter and the Celest CLI installed on your machine.
15 |
16 | 1. Install Flutter v3.29.0 or later from the [official website](https://docs.flutter.dev/get-started/install)
17 | 2. Download and install the Celest CLI
18 |
19 | <div className="flex flex-col items-center space-y-4 my-6">
20 | <DownloadButton />
21 | </div>
22 |
23 | ## Creating a project
24 |
25 | Once you have the CLI installed, you can create a new project by running the following command:
26 |
27 | ```bash
28 | $ celest init
29 | ```
30 |
31 | You can run this command from within your Flutter project which will create a new `celest/` directory for your project. Or you can run
32 | this in another directory to have a standalone Celest project.
33 |
34 | Once you have a project, run `celest start` to start a local development environment.
35 |
36 | ```bash
37 | $ celest start
38 | ✓ Celest is running on http://localhost:7777
39 | ```
40 |
41 | This command will start a local server which will run in the background as you write your backend logic. As you make changes to the files in the `celest/` directory,
42 | the server will hot-reload those changes so you can see them live.
43 |
44 | To interact with the running environment, Celest will generate a Dart client which you can use in any Dart or Flutter project. This client
45 | is generated in the `client/` directory of your `celest/` folder. As you make changes in the local environment, this client will be updated to reflect those changes.
46 |
47 | ### Example
48 |
49 | Here is an example of a simple Celest function:
50 |
51 | ```dart
52 | import 'package:celest/celest.dart';
53 |
54 | @cloud
55 | Future<String> sayHello(String name) async {
56 | print('Saying hello to $name');
57 | return 'Hello, $name';
58 | }
59 | ```
60 |
61 | This function can be called from a Dart project like so:
62 |
63 | ```dart
64 | import 'package:my_project_client/my_project_client.dart';
65 |
66 | Future<void> main() async {
67 | celest.init(environment: CelestEnvironment.local);
68 | final response = await celest.functions.sayHello('World');
69 | print(response); // Hello, World
70 | }
71 | ```
72 |
73 | ## Next steps
74 |
75 | Ready to start building? Choose which part of your backend you want to work on first:
76 |
77 | <div className="my-8">
78 | <Cards displayName="Features">
79 | <Card icon={<FunctionsIcon />} title="Functions" href="/docs/functions" />
80 | <Card icon={<AuthIcon />} title="Auth" href="/docs/auth" />
81 | <Card icon={<DataIcon />} title="Data" href="/docs/data" />
82 | </Cards>
83 | </div>
84 |
--------------------------------------------------------------------------------
/pages/docs/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: What is Celest?
3 | description: Learn more about Celest and how it helps you build the backend for your Flutter app.
4 | ---
5 |
6 | import { Callout } from 'nextra/components'
7 | import { IntroducingCelest } from '@components/IntroducingCelest'
8 | import { CloudFunctionsDemo } from '@components/CloudFunctionsDemo'
9 | import { Cards, Card } from 'nextra/components'
10 | import { FunctionsIcon, AuthIcon, DataIcon, PoliciesIcon, StorageIcon, WebsiteIcon } from '@components/icons'
11 |
12 | # Overview
13 |
14 | ## What is Celest?
15 |
16 | Celest is a backend-as-a-service for Flutter developers that enables you to build your backend entirely in Dart. Build the use cases you need without any additional tooling or context switching to different programming languages. Celest lets you write your backend in Dart, enabling you to share logic between your Flutter app and your backend.
17 |
18 | <IntroducingCelest />
19 |
20 | ## What can I build with Celest?
21 |
22 | Celest offers the following building blocks for your backend:
23 |
24 | <div className="my-8">
25 | <Cards displayName="Features">
26 | <div className="flex flex-col">
27 | <Card icon={<FunctionsIcon />} title="Functions" href="/docs/functions" />
28 | <p className="text-sm text-gray-200 font-medium my-6 px-2 text-center">Build functions that run in the cloud with your custom business logic.</p>
29 | </div>
30 | <div className="flex flex-col">
31 | <Card icon={<AuthIcon />} title="Auth" href="/docs/auth" />
32 | <p className="text-sm text-gray-200 font-medium my-6 px-2 text-center">Authenticate your users with social sign-in, passwordless and WebAuthn.</p>
33 | </div>
34 | <div className="flex flex-col">
35 | <Card icon={<DataIcon />} title="Data" href="/docs/data" />
36 | <p className="text-sm text-gray-200 font-medium my-6 px-2 text-center">Define your SQL types and relationships in Dart code.</p>
37 | </div>
38 | <div className="flex flex-col">
39 | <Card icon={<PoliciesIcon />} title="Policies (coming soon)" href="#" />
40 | <p className="text-sm text-gray-200 font-medium my-6 px-2 text-center">Author fine-grained access controls for all your backend components.</p>
41 | </div>
42 | <div className="flex flex-col">
43 | <Card icon={<StorageIcon />} title="Storage (coming soon)" href="#" />
44 | <p className="text-sm text-gray-200 font-medium my-6 px-2 text-center">Serve content globally with edge caching built-in.</p>
45 | </div>
46 | <div className="flex flex-col">
47 | <Card icon={<WebsiteIcon />} title="Web (coming soon)" href="#" />
48 | <p className="text-sm text-gray-200 font-medium my-6 px-2 text-center">Integated hosting for Dart and Flutter web apps.</p>
49 | </div>
50 | </Cards>
51 | </div>
52 |
53 | _Something we're missing that you'd like to see?_ Let us know by [creating an issue](https://github.com/celest-dev/celest/issues/new/choose)
54 | in our GitHub repo or chatting with us on [Discord](/discord).
55 |
56 | ## How do I use Celest?
57 |
58 | You primarily interact with Celest using the [Celest CLI](/docs/download).
59 |
60 | Once you download and install the CLI, run `celest start` from your Flutter project to create the `celest` folder. This folder contains all of your backend logic. The CLI will watch for changes in this folder and hot-reload your backend as you work. A client library is automatically generated for you in your Flutter app. When you feel confident with your changes, use the CLI to [deploy](/docs/deploy) your backend to the cloud.
61 |
62 | Celest offers a set of "Cloud Widgets"—constructs that encapsulate functionality on the backend. Using these widgets you can declaratively define your backend features such as serverless functions and authentication.
63 |
64 | <CloudFunctionsDemo />
65 |
66 | ## Next steps
67 |
68 | Follow the next guide to [set up the CLI](/docs/get-started.md) and get started building your backend in Dart.
69 |
--------------------------------------------------------------------------------
/pages/docs/self-hosting.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Self-Hosting
3 | description: Learn how to self-host your Celest project anywhere a Docker container runs.
4 | ---
5 |
6 | import { Callout } from 'nextra/components'
7 |
8 | # Self-Hosting
9 |
10 | As of Celest V1, all Celest projects can be self-hosted on any server that can run a Docker container. This means you can deploy your Celest project
11 | to any cloud provider, on-premises server, or even your own computer.
12 |
13 | Self-hosting support is provided via the `celest build` command which will bundle all of the dependencies of your Celest project into a
14 | lightweight Docker container. The container will be pre-configured with all the necessary environment variables and settings to run your
15 | Celest project.
16 |
--------------------------------------------------------------------------------
/pages/index.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Celest | The Flutter cloud platform
3 | description: Celest is a Flutter cloud platform that allows you to build, deploy, and manage backends for your Flutter app with ease.
4 | ---
5 |
6 | import { Tabs, Steps } from 'nextra/components'
7 | import { Bleed } from 'nextra-theme-docs'
8 | import Link from 'next/link'
9 | import Image from 'next/image'
10 |
11 | import Hero from '@components/landing/Hero'
12 | import Newsletter from '@components/landing/Newsletter'
13 | import Content from '@components/landing/Content'
14 | import { Download } from '@components/Download'
15 | import { Feature, FeatureSet } from '@components/landing/Feature'
16 |
17 | <Hero />
18 |
19 | <hr className="mt-8 py-4" />
20 |
21 | <Bleed>
22 | <FeatureSet>
23 | <Feature
24 | title="All your backend logic in Dart"
25 | description={<>Annotate any Dart function with <code>@cloud</code> to turn it into a serverless function.</>}
26 | >
27 | ```dart
28 | @cloud
29 | Future<String> sayHello(String name) async {
30 | return 'Hello, $name!';
31 | }
32 | ```
33 | </Feature>
34 | <Feature
35 | title={<>Out-of-the-box database</>}
36 | description="Celest takes your Drift schema and automatically creates a database for you."
37 | >
38 | <div className="flex flex-row justify-center items-stretch flex-wrap">
39 |
40 | <div className="h-full m-2">
41 | ```dart filename="database.dart"
42 | import 'package:drift/drift.dart';
43 |
44 | class Tasks extends Table {
45 | late id = integer().autoIncrement()();
46 | late title = text()();
47 | late completed = boolean()();
48 | }
49 | ```
50 | </div>
51 | <div className="h-full m-2">
52 | ```dart filename="project.dart"
53 | import 'package:celest/celest.dart';
54 |
55 | const tasks = Database(
56 | schema: Schema.drift(TaskDatabase),
57 | );
58 | ```
59 | </div>
60 | </div>
61 | </Feature>
62 | <Feature
63 | title="Deploy in a single command"
64 | description="When you're ready to productionize, run `celest deploy`. That's it!"
65 | >
66 | ```ansi
67 | $ celest deploy
68 | [0m [0;32m✓ [0mInitializing Celest (5ms)
69 | [0m [0;32m✓ [0mProject successfully migrated (1.7s)
70 | [0m [0;32m✓ [0m🔥 Warming up the engines (12.3s)
71 | [0m [0;32m✓ [0m✨ Contacting the Celestials (10.0s)
72 | [0m [0;32m✓ [0m🚀 Deploying to Celest Cloud (38.7s)
73 | 💙 [0m [0;32mYour Celest project has been deployed![0m
74 | https://my-project-a18bbb.us-south1.celest.cloud
75 | ```
76 | </Feature>
77 | </FeatureSet>
78 |
79 | </Bleed>
80 |
81 | <hr className="my-12" />
82 | <Content />
83 |
--------------------------------------------------------------------------------
/postcss.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | plugins: {
3 | tailwindcss: {},
4 | autoprefixer: {},
5 | },
6 | }
7 |
--------------------------------------------------------------------------------
/public/android-chrome-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/android-chrome-192x192.png
--------------------------------------------------------------------------------
/public/android-chrome-512x512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/android-chrome-512x512.png
--------------------------------------------------------------------------------
/public/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/apple-touch-icon.png
--------------------------------------------------------------------------------
/public/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/favicon-16x16.png
--------------------------------------------------------------------------------
/public/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/favicon-32x32.png
--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/favicon.ico
--------------------------------------------------------------------------------
/public/fonts/BerkeleyMono-Regular.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/BerkeleyMono-Regular.ttf
--------------------------------------------------------------------------------
/public/fonts/BerkeleyMono-Regular.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/BerkeleyMono-Regular.woff2
--------------------------------------------------------------------------------
/public/fonts/Poppins.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins.woff2
--------------------------------------------------------------------------------
/public/fonts/Poppins/OFL.txt:
--------------------------------------------------------------------------------
1 | Copyright 2020 The Poppins Project Authors (https://github.com/itfoundry/Poppins)
2 |
3 | This Font Software is licensed under the SIL Open Font License, Version 1.1.
4 | This license is copied below, and is also available with a FAQ at:
5 | https://openfontlicense.org
6 |
7 |
8 | -----------------------------------------------------------
9 | SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10 | -----------------------------------------------------------
11 |
12 | PREAMBLE
13 | The goals of the Open Font License (OFL) are to stimulate worldwide
14 | development of collaborative font projects, to support the font creation
15 | efforts of academic and linguistic communities, and to provide a free and
16 | open framework in which fonts may be shared and improved in partnership
17 | with others.
18 |
19 | The OFL allows the licensed fonts to be used, studied, modified and
20 | redistributed freely as long as they are not sold by themselves. The
21 | fonts, including any derivative works, can be bundled, embedded,
22 | redistributed and/or sold with any software provided that any reserved
23 | names are not used by derivative works. The fonts and derivatives,
24 | however, cannot be released under any other type of license. The
25 | requirement for fonts to remain under this license does not apply
26 | to any document created using the fonts or their derivatives.
27 |
28 | DEFINITIONS
29 | "Font Software" refers to the set of files released by the Copyright
30 | Holder(s) under this license and clearly marked as such. This may
31 | include source files, build scripts and documentation.
32 |
33 | "Reserved Font Name" refers to any names specified as such after the
34 | copyright statement(s).
35 |
36 | "Original Version" refers to the collection of Font Software components as
37 | distributed by the Copyright Holder(s).
38 |
39 | "Modified Version" refers to any derivative made by adding to, deleting,
40 | or substituting -- in part or in whole -- any of the components of the
41 | Original Version, by changing formats or by porting the Font Software to a
42 | new environment.
43 |
44 | "Author" refers to any designer, engineer, programmer, technical
45 | writer or other person who contributed to the Font Software.
46 |
47 | PERMISSION & CONDITIONS
48 | Permission is hereby granted, free of charge, to any person obtaining
49 | a copy of the Font Software, to use, study, copy, merge, embed, modify,
50 | redistribute, and sell modified and unmodified copies of the Font
51 | Software, subject to the following conditions:
52 |
53 | 1) Neither the Font Software nor any of its individual components,
54 | in Original or Modified Versions, may be sold by itself.
55 |
56 | 2) Original or Modified Versions of the Font Software may be bundled,
57 | redistributed and/or sold with any software, provided that each copy
58 | contains the above copyright notice and this license. These can be
59 | included either as stand-alone text files, human-readable headers or
60 | in the appropriate machine-readable metadata fields within text or
61 | binary files as long as those fields can be easily viewed by the user.
62 |
63 | 3) No Modified Version of the Font Software may use the Reserved Font
64 | Name(s) unless explicit written permission is granted by the corresponding
65 | Copyright Holder. This restriction only applies to the primary font name as
66 | presented to the users.
67 |
68 | 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69 | Software shall not be used to promote, endorse or advertise any
70 | Modified Version, except to acknowledge the contribution(s) of the
71 | Copyright Holder(s) and the Author(s) or with their explicit written
72 | permission.
73 |
74 | 5) The Font Software, modified or unmodified, in part or in whole,
75 | must be distributed entirely under this license, and must not be
76 | distributed under any other license. The requirement for fonts to
77 | remain under this license does not apply to any document created
78 | using the Font Software.
79 |
80 | TERMINATION
81 | This license becomes null and void if any of the above conditions are
82 | not met.
83 |
84 | DISCLAIMER
85 | THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88 | OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89 | COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90 | INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91 | DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92 | FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93 | OTHER DEALINGS IN THE FONT SOFTWARE.
94 |
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-Black.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-Black.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-BlackItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-BlackItalic.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-Bold.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-Bold.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-BoldItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-BoldItalic.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-ExtraBold.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-ExtraBold.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-ExtraBoldItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-ExtraBoldItalic.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-ExtraLight.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-ExtraLight.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-ExtraLightItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-ExtraLightItalic.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-Italic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-Italic.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-Light.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-Light.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-LightItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-LightItalic.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-Medium.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-Medium.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-MediumItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-MediumItalic.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-Regular.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-Regular.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-SemiBold.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-SemiBold.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-SemiBoldItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-SemiBoldItalic.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-Thin.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-Thin.ttf
--------------------------------------------------------------------------------
/public/fonts/Poppins/Poppins-ThinItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/fonts/Poppins/Poppins-ThinItalic.ttf
--------------------------------------------------------------------------------
/public/img/annotate-all-the-things.jpeg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/annotate-all-the-things.jpeg
--------------------------------------------------------------------------------
/public/img/celest-deploy.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/celest-deploy.png
--------------------------------------------------------------------------------
/public/img/celest-start-ts.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/celest-start-ts.png
--------------------------------------------------------------------------------
/public/img/celest-start.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/celest-start.png
--------------------------------------------------------------------------------
/public/img/cloud-functions-demo-avc1.mp4:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/cloud-functions-demo-avc1.mp4
--------------------------------------------------------------------------------
/public/img/cloud-functions-demo-hevc.mp4:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/cloud-functions-demo-hevc.mp4
--------------------------------------------------------------------------------
/public/img/cloud-functions-demo.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/cloud-functions-demo.jpg
--------------------------------------------------------------------------------
/public/img/cloud-functions-demo.vtt:
--------------------------------------------------------------------------------
1 | WEBVTT
2 |
3 | 00:00:00.000 --> 00:00:02.250
4 | Let's create a Celest Function!
5 |
6 | 00:00:02.280 --> 00:00:05.050
7 | Start by running `celest start`
8 | from your Flutter app.
9 |
10 | 00:00:05.080 --> 00:00:07.490
11 | Then choose a name for your project.
12 |
13 | 00:00:07.520 --> 00:00:11.810
14 | And in just a few seconds, you've got
15 | a Celest backend generated for you.
16 |
17 | 00:00:11.840 --> 00:00:13.210
18 | To add a new cloud function,
19 |
20 | 00:00:13.240 --> 00:00:16.850
21 | navigate to the "functions"
22 | folder and choose an API file.
23 |
24 | 00:00:16.880 --> 00:00:20.730
25 | Give your function a name and write it
26 | like you would any other Dart function.
27 |
28 | 00:00:20.763 --> 00:00:23.914
29 | Next, import the generated
30 | Flutter client and call `celest.init()`
31 |
32 | 00:00:23.947 --> 00:00:26.957
33 | at the start of your app.
34 |
35 | 00:00:30.040 --> 00:00:31.610
36 | The client is strongly typed
37 |
38 | 00:00:31.640 --> 00:00:35.320
39 | and matches the names of your
40 | cloud functions in your backend.
41 |
42 | 00:00:35.320 --> 00:00:36.640
43 | And Celest handles the serialization for you,
44 |
45 | 00:00:36.670 --> 00:00:39.610
46 | so you can just focus
47 | on writing your logic.
48 |
49 | 00:00:39.640 --> 00:00:42.410
50 | That's right!
51 | No more JSON serializable.
52 |
53 | 00:00:42.440 --> 00:00:44.240
54 | Start for free at celest.dev
55 |
56 |
--------------------------------------------------------------------------------
/public/img/cloud-functions-demo.webm:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/cloud-functions-demo.webm
--------------------------------------------------------------------------------
/public/img/coming-soon.svg:
--------------------------------------------------------------------------------
1 | <svg width="81" height="19" viewBox="0 0 81 19" fill="none" xmlns="http://www.w3.org/2000/svg">
2 | <rect width="81" height="19" rx="9.5" fill="#4798EB"/>
3 | <path d="M14.133 12.09C13.4397 12.09 12.8464 11.9433 12.353 11.65C11.8597 11.3567 11.4797 10.94 11.213 10.4C10.953 9.86 10.823 9.21667 10.823 8.47C10.823 7.73 10.953 7.09 11.213 6.55C11.4797 6.01 11.8597 5.59333 12.353 5.3C12.8464 5.00667 13.4397 4.86 14.133 4.86C14.6197 4.86 15.0664 4.93667 15.473 5.09C15.8864 5.24333 16.2364 5.46667 16.523 5.76L16.203 6.43C15.8964 6.14333 15.5764 5.93667 15.243 5.81C14.9164 5.67667 14.553 5.61 14.153 5.61C13.3597 5.61 12.753 5.86 12.333 6.36C11.913 6.86 11.703 7.56333 11.703 8.47C11.703 9.38333 11.913 10.09 12.333 10.59C12.753 11.09 13.3597 11.34 14.153 11.34C14.553 11.34 14.9164 11.2767 15.243 11.15C15.5764 11.0167 15.8964 10.8067 16.203 10.52L16.523 11.19C16.2364 11.4767 15.8864 11.7 15.473 11.86C15.0664 12.0133 14.6197 12.09 14.133 12.09ZM19.37 12.09C18.8967 12.09 18.4867 11.9867 18.14 11.78C17.7933 11.5733 17.5233 11.2833 17.33 10.91C17.1433 10.53 17.05 10.0833 17.05 9.57C17.05 9.05667 17.1433 8.61333 17.33 8.24C17.5233 7.86 17.7933 7.56667 18.14 7.36C18.4867 7.15333 18.8967 7.05 19.37 7.05C19.8367 7.05 20.2433 7.15333 20.59 7.36C20.9433 7.56667 21.2133 7.86 21.4 8.24C21.5933 8.61333 21.69 9.05667 21.69 9.57C21.69 10.0833 21.5933 10.53 21.4 10.91C21.2133 11.2833 20.9433 11.5733 20.59 11.78C20.2433 11.9867 19.8367 12.09 19.37 12.09ZM19.37 11.44C19.8233 11.44 20.1867 11.28 20.46 10.96C20.7333 10.6333 20.87 10.17 20.87 9.57C20.87 8.96333 20.7333 8.5 20.46 8.18C20.1867 7.86 19.8233 7.7 19.37 7.7C18.91 7.7 18.5433 7.86 18.27 8.18C18.0033 8.5 17.87 8.96333 17.87 9.57C17.87 10.17 18.0033 10.6333 18.27 10.96C18.5433 11.28 18.91 11.44 19.37 11.44ZM22.9266 12V7.14H23.7166V7.96C23.8633 7.66667 24.0666 7.44333 24.3266 7.29C24.5866 7.13 24.89 7.05 25.2366 7.05C25.9966 7.05 26.4833 7.38 26.6966 8.04C26.8433 7.73333 27.06 7.49333 27.3466 7.32C27.6333 7.14 27.9633 7.05 28.3366 7.05C29.4166 7.05 29.9566 7.69 29.9566 8.97V12H29.1466V9.01C29.1466 8.56333 29.0666 8.23667 28.9066 8.03C28.7533 7.81667 28.4966 7.71 28.1366 7.71C27.7433 7.71 27.43 7.85 27.1966 8.13C26.9633 8.41 26.8466 8.78333 26.8466 9.25V12H26.0366V9.01C26.0366 8.56333 25.9566 8.23667 25.7966 8.03C25.6433 7.81667 25.3866 7.71 25.0266 7.71C24.6266 7.71 24.31 7.85 24.0766 8.13C23.85 8.41 23.7366 8.78333 23.7366 9.25V12H22.9266ZM31.3711 5.93V5.02H32.3711V5.93H31.3711ZM31.4711 12V7.14H32.2811V12H31.4711ZM33.7953 12V7.14H34.5853V7.97C34.7453 7.66333 34.972 7.43333 35.2653 7.28C35.5586 7.12667 35.8886 7.05 36.2553 7.05C37.4086 7.05 37.9853 7.69 37.9853 8.97V12H37.1753V9.02C37.1753 8.56667 37.0853 8.23667 36.9053 8.03C36.732 7.81667 36.452 7.71 36.0653 7.71C35.6186 7.71 35.262 7.85 34.9953 8.13C34.7353 8.40333 34.6053 8.77 34.6053 9.23V12H33.7953ZM41.6289 13.89C41.2089 13.89 40.8122 13.8333 40.4389 13.72C40.0722 13.6133 39.7456 13.45 39.4589 13.23L39.7289 12.64C40.0289 12.8533 40.3256 13.0067 40.6189 13.1C40.9189 13.1933 41.2422 13.24 41.5889 13.24C42.5489 13.24 43.0289 12.7467 43.0289 11.76V10.9C42.8889 11.2067 42.6689 11.45 42.3689 11.63C42.0756 11.8033 41.7389 11.89 41.3589 11.89C40.9122 11.89 40.5256 11.7867 40.1989 11.58C39.8722 11.3733 39.6189 11.09 39.4389 10.73C39.2656 10.3633 39.1789 9.94 39.1789 9.46C39.1789 8.98 39.2656 8.56 39.4389 8.2C39.6189 7.83333 39.8722 7.55 40.1989 7.35C40.5256 7.15 40.9122 7.05 41.3589 7.05C41.7389 7.05 42.0756 7.13667 42.3689 7.31C42.6689 7.48333 42.8889 7.72 43.0289 8.02V7.14H43.8189V11.65C43.8189 12.3967 43.6322 12.9567 43.2589 13.33C42.8922 13.7033 42.3489 13.89 41.6289 13.89ZM41.5089 11.23C41.9756 11.23 42.3456 11.07 42.6189 10.75C42.8922 10.43 43.0289 10 43.0289 9.46C43.0289 8.92 42.8922 8.49333 42.6189 8.18C42.3456 7.86 41.9756 7.7 41.5089 7.7C41.0489 7.7 40.6822 7.86 40.4089 8.18C40.1356 8.49333 39.9989 8.92 39.9989 9.46C39.9989 10 40.1356 10.43 40.4089 10.75C40.6822 11.07 41.0489 11.23 41.5089 11.23ZM50.2966 12.09C49.7433 12.09 49.2433 12.02 48.7966 11.88C48.35 11.7333 47.9633 11.5233 47.6366 11.25L47.9266 10.59C48.2666 10.85 48.6233 11.0433 48.9966 11.17C49.37 11.2967 49.8033 11.36 50.2966 11.36C50.8966 11.36 51.34 11.25 51.6266 11.03C51.92 10.8033 52.0666 10.5067 52.0666 10.14C52.0666 9.84667 51.96 9.61333 51.7466 9.44C51.54 9.26667 51.19 9.13 50.6966 9.03L49.6566 8.82C49.03 8.68667 48.56 8.47 48.2466 8.17C47.94 7.86333 47.7866 7.45667 47.7866 6.95C47.7866 6.53 47.8933 6.16333 48.1066 5.85C48.3266 5.53667 48.63 5.29333 49.0166 5.12C49.4033 4.94667 49.85 4.86 50.3566 4.86C50.83 4.86 51.27 4.93667 51.6766 5.09C52.0833 5.23667 52.4266 5.45 52.7066 5.73L52.4166 6.37C52.1166 6.09667 51.8 5.9 51.4666 5.78C51.1333 5.65333 50.76 5.59 50.3466 5.59C49.82 5.59 49.4 5.71333 49.0866 5.96C48.7733 6.2 48.6166 6.52 48.6166 6.92C48.6166 7.24 48.7133 7.49333 48.9066 7.68C49.1066 7.86667 49.43 8.00333 49.8766 8.09L50.9166 8.31C51.59 8.45 52.0866 8.66333 52.4066 8.95C52.7333 9.23 52.8966 9.61333 52.8966 10.1C52.8966 10.4933 52.79 10.84 52.5766 11.14C52.37 11.44 52.07 11.6733 51.6766 11.84C51.29 12.0067 50.83 12.09 50.2966 12.09ZM56.079 12.09C55.6056 12.09 55.1956 11.9867 54.849 11.78C54.5023 11.5733 54.2323 11.2833 54.039 10.91C53.8523 10.53 53.759 10.0833 53.759 9.57C53.759 9.05667 53.8523 8.61333 54.039 8.24C54.2323 7.86 54.5023 7.56667 54.849 7.36C55.1956 7.15333 55.6056 7.05 56.079 7.05C56.5456 7.05 56.9523 7.15333 57.299 7.36C57.6523 7.56667 57.9223 7.86 58.109 8.24C58.3023 8.61333 58.399 9.05667 58.399 9.57C58.399 10.0833 58.3023 10.53 58.109 10.91C57.9223 11.2833 57.6523 11.5733 57.299 11.78C56.9523 11.9867 56.5456 12.09 56.079 12.09ZM56.079 11.44C56.5323 11.44 56.8956 11.28 57.169 10.96C57.4423 10.6333 57.579 10.17 57.579 9.57C57.579 8.96333 57.4423 8.5 57.169 8.18C56.8956 7.86 56.5323 7.7 56.079 7.7C55.619 7.7 55.2523 7.86 54.979 8.18C54.7123 8.5 54.579 8.96333 54.579 9.57C54.579 10.17 54.7123 10.6333 54.979 10.96C55.2523 11.28 55.619 11.44 56.079 11.44ZM61.6356 12.09C61.1623 12.09 60.7523 11.9867 60.4056 11.78C60.059 11.5733 59.789 11.2833 59.5956 10.91C59.409 10.53 59.3156 10.0833 59.3156 9.57C59.3156 9.05667 59.409 8.61333 59.5956 8.24C59.789 7.86 60.059 7.56667 60.4056 7.36C60.7523 7.15333 61.1623 7.05 61.6356 7.05C62.1023 7.05 62.509 7.15333 62.8556 7.36C63.209 7.56667 63.479 7.86 63.6656 8.24C63.859 8.61333 63.9556 9.05667 63.9556 9.57C63.9556 10.0833 63.859 10.53 63.6656 10.91C63.479 11.2833 63.209 11.5733 62.8556 11.78C62.509 11.9867 62.1023 12.09 61.6356 12.09ZM61.6356 11.44C62.089 11.44 62.4523 11.28 62.7256 10.96C62.999 10.6333 63.1356 10.17 63.1356 9.57C63.1356 8.96333 62.999 8.5 62.7256 8.18C62.4523 7.86 62.089 7.7 61.6356 7.7C61.1756 7.7 60.809 7.86 60.5356 8.18C60.269 8.5 60.1356 8.96333 60.1356 9.57C60.1356 10.17 60.269 10.6333 60.5356 10.96C60.809 11.28 61.1756 11.44 61.6356 11.44ZM65.1723 12V7.14H65.9623V7.97C66.1223 7.66333 66.3489 7.43333 66.6423 7.28C66.9356 7.12667 67.2656 7.05 67.6323 7.05C68.7856 7.05 69.3623 7.69 69.3623 8.97V12H68.5523V9.02C68.5523 8.56667 68.4623 8.23667 68.2823 8.03C68.1089 7.81667 67.8289 7.71 67.4423 7.71C66.9956 7.71 66.6389 7.85 66.3723 8.13C66.1123 8.40333 65.9823 8.77 65.9823 9.23V12H65.1723ZM70.9859 10.16L70.7359 4.95H71.7359L71.4859 10.16H70.9859ZM70.7259 12V10.98H71.7459V12H70.7259Z" fill="white"/>
4 | </svg>
5 |
--------------------------------------------------------------------------------
/public/img/deploy.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/deploy.gif
--------------------------------------------------------------------------------
/public/img/dillon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/dillon.png
--------------------------------------------------------------------------------
/public/img/dillon.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/dillon.webp
--------------------------------------------------------------------------------
/public/img/discord.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/discord.png
--------------------------------------------------------------------------------
/public/img/fluttering-in-the-sky.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/fluttering-in-the-sky.webp
--------------------------------------------------------------------------------
/public/img/introducing-celest.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/introducing-celest.jpg
--------------------------------------------------------------------------------
/public/img/introducing-celest.mp4:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/introducing-celest.mp4
--------------------------------------------------------------------------------
/public/img/introducing-celest.vtt:
--------------------------------------------------------------------------------
1 | WEBVTT
2 |
3 | 00:00:00.080 --> 00:00:01.640
4 | Developers are using Flutter to build
5 |
6 | 00:00:01.660 --> 00:00:05.040
7 | cross-platform applications to quickly
8 | reach users on any device,
9 |
10 | 00:00:05.040 --> 00:00:08.680
11 | but when it comes to building the back
12 | end, their time is spent switching between
13 |
14 | 00:00:08.710 --> 00:00:11.340
15 | different programing
16 | languages and toolchains.
17 |
18 | 00:00:11.370 --> 00:00:14.080
19 | Introducing Celest. Celest is a service
20 |
21 | 00:00:14.110 --> 00:00:17.620
22 | that turns every Flutter developer
23 | into a full-stack developer.
24 |
25 | 00:00:17.640 --> 00:00:19.320
26 | To start using Celest in your Flutter
27 |
28 | 00:00:19.350 --> 00:00:23.540
29 | project, just run `celest start`,
30 | add your project name, and voila!
31 |
32 | 00:00:23.570 --> 00:00:26.120
33 | Your Celest backend is
34 | created and ready to go.
35 |
36 | 00:00:26.120 --> 00:00:29.160
37 | In the Celest folder,
38 | you create the APIs your app needs as
39 |
40 | 00:00:29.190 --> 00:00:31.960
41 | top level Dart functions,
42 | and when you hit save,
43 |
44 | 00:00:31.990 --> 00:00:35.340
45 | the Celest CLI detects the change
46 | and hot reloads your backend.
47 |
48 | 00:00:35.360 --> 00:00:38.880
49 | In your Flutter app, you use the generated
50 | client from Celest to connect to your
51 |
52 | 00:00:38.910 --> 00:00:43.160
53 | backend, and when you are confident
54 | with your changes, just run `celest deploy`,
55 |
56 | 00:00:43.180 --> 00:00:46.500
57 | and your backend is
58 | deployed and managed for you.
59 |
60 | 00:00:46.530 --> 00:00:48.900
61 | With Celest, no more context switching.
62 |
63 | 00:00:48.930 --> 00:00:52.540
64 | You write every part of your Flutter
65 | app in Dart, right in your IDE.
66 |
67 | 00:00:52.570 --> 00:00:56.080
68 | Learn more about Celest
69 | by visiting our website celest.dev
70 |
--------------------------------------------------------------------------------
/public/img/introducing-celest.webm:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/introducing-celest.webm
--------------------------------------------------------------------------------
/public/img/logo-full.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/logo-full.png
--------------------------------------------------------------------------------
/public/img/logo-small.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/logo-small.png
--------------------------------------------------------------------------------
/public/img/logo-small.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/logo-small.webp
--------------------------------------------------------------------------------
/public/img/logo-white.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/logo-white.png
--------------------------------------------------------------------------------
/public/img/logo-xsmall.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/logo-xsmall.png
--------------------------------------------------------------------------------
/public/img/logo-xsmall.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/logo-xsmall.webp
--------------------------------------------------------------------------------
/public/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/logo.png
--------------------------------------------------------------------------------
/public/img/logo.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/logo.webp
--------------------------------------------------------------------------------
/public/img/open-graph.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/open-graph.png
--------------------------------------------------------------------------------
/public/img/pricing.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/pricing.png
--------------------------------------------------------------------------------
/public/img/pricing.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/pricing.webp
--------------------------------------------------------------------------------
/public/img/x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/x.png
--------------------------------------------------------------------------------
/public/img/x.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/celest-dev/website/52b36987c64dafebc23000a75788f5430d28e03f/public/img/x.webp
--------------------------------------------------------------------------------
/public/img/youtube.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" fill="none" class="sbui-icon" viewBox="0 0 16 16"><path fill="currentColor" fill-rule="evenodd" d="M15.666 4.135a2.01 2.01 0 0 0-1.415-1.423C13.003 2.375 8 2.375 8 2.375s-5.003 0-6.251.337A2.01 2.01 0 0 0 .334 4.135C0 5.391 0 8.011 0 8.011s0 2.62.334 3.877a1.98 1.98 0 0 0 1.415 1.4c1.248.337 6.251.337 6.251.337s5.003 0 6.251-.336a1.98 1.98 0 0 0 1.415-1.402C16 10.633 16 8.011 16 8.011s0-2.62-.334-3.876ZM6.364 10.39V5.632l4.181 2.38-4.181 2.378Z" clip-rule="evenodd"/></svg>
--------------------------------------------------------------------------------
/public/robots.txt:
--------------------------------------------------------------------------------
1 | User-agent: *
2 | Allow: /
3 | Sitemap: https://www.celest.dev/sitemap.xml
--------------------------------------------------------------------------------
/public/sitemap-0.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">
3 | <url><loc>https://www.celest.dev</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
4 | <url><loc>https://www.celest.dev/blog</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
5 | <url><loc>https://www.celest.dev/blog/fluttering-in-the-sky</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
6 | <url><loc>https://www.celest.dev/blog/how-we-want-to-backend</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
7 | <url><loc>https://www.celest.dev/blog/local-iterations-release</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
8 | <url><loc>https://www.celest.dev/compliance</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
9 | <url><loc>https://www.celest.dev/discord</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
10 | <url><loc>https://www.celest.dev/docs</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
11 | <url><loc>https://www.celest.dev/docs/auth</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
12 | <url><loc>https://www.celest.dev/docs/auth/celest-auth</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
13 | <url><loc>https://www.celest.dev/docs/auth/firebase-auth</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
14 | <url><loc>https://www.celest.dev/docs/auth/supabase-auth</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
15 | <url><loc>https://www.celest.dev/docs/auth/using-the-auth-client</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
16 | <url><loc>https://www.celest.dev/docs/cli-commands-reference</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
17 | <url><loc>https://www.celest.dev/docs/data</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
18 | <url><loc>https://www.celest.dev/docs/download</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
19 | <url><loc>https://www.celest.dev/docs/folder-structure</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
20 | <url><loc>https://www.celest.dev/docs/functions</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
21 | <url><loc>https://www.celest.dev/docs/functions/authorizing-functions</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
22 | <url><loc>https://www.celest.dev/docs/functions/creating-functions</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
23 | <url><loc>https://www.celest.dev/docs/functions/customizing-serialization</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
24 | <url><loc>https://www.celest.dev/docs/functions/data-types</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
25 | <url><loc>https://www.celest.dev/docs/functions/env-variables</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
26 | <url><loc>https://www.celest.dev/docs/functions/exceptions</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
27 | <url><loc>https://www.celest.dev/docs/functions/http</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
28 | <url><loc>https://www.celest.dev/docs/functions/http/conventions</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
29 | <url><loc>https://www.celest.dev/docs/functions/http/customization</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
30 | <url><loc>https://www.celest.dev/docs/functions/logging</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
31 | <url><loc>https://www.celest.dev/docs/functions/packages</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
32 | <url><loc>https://www.celest.dev/docs/functions/testing</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
33 | <url><loc>https://www.celest.dev/docs/get-started</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
34 | <url><loc>https://www.celest.dev/docs/self-hosting</loc><lastmod>2025-03-13T15:30:51.981Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
35 | </urlset>
--------------------------------------------------------------------------------
/public/sitemap.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
3 | <sitemap><loc>https://www.celest.dev/sitemap-0.xml</loc></sitemap>
4 | </sitemapindex>
--------------------------------------------------------------------------------
/sentry.client.config.ts:
--------------------------------------------------------------------------------
1 | // This file configures the initialization of Sentry on the client.
2 | // The config you add here will be used whenever a users loads a page in their browser.
3 | // https://docs.sentry.io/platforms/javascript/guides/nextjs/
4 |
5 | import * as Sentry from "@sentry/nextjs";
6 |
7 | Sentry.init({
8 | dsn: "https://5e1c9ebbaa5b3f636fc63ba5003412d2@o4506345201532928.ingest.us.sentry.io/4506345292693504",
9 |
10 | // Adjust this value in production, or use tracesSampler for greater control
11 | tracesSampleRate: 1,
12 |
13 | // Setting this option to true will print useful information to the console while you're setting up Sentry.
14 | debug: false,
15 |
16 | replaysOnErrorSampleRate: 1.0,
17 |
18 | // This sets the sample rate to be 10%. You may want this to be 100% while
19 | // in development and sample at a lower rate in production
20 | replaysSessionSampleRate: 0.1,
21 |
22 | // You can remove this option if you're not planning to use the Sentry Session Replay feature:
23 | integrations: [
24 | Sentry.replayIntegration({
25 | // Additional Replay configuration goes in here, for example:
26 | maskAllText: true,
27 | blockAllMedia: true,
28 | }),
29 | ],
30 | });
31 |
--------------------------------------------------------------------------------
/src/analytics.ts:
--------------------------------------------------------------------------------
1 | import type { PostHog } from 'posthog-js';
2 |
3 | type EventProps = {
4 | category?: string;
5 | errorMessage?: String;
6 | success?: boolean;
7 | downloadCLIAutoDetectOperatingSystem?: boolean;
8 | downloadCLIOperatingSystemName?: string;
9 | downloadCLIOperatingSystemArchitecture?: string;
10 | };
11 |
12 | export const recordEvent = (posthog: PostHog, eventName: string, props?: EventProps) => {
13 | posthog.capture(eventName, props);
14 | };
15 |
16 |
17 | export const identifyUser = (posthog: PostHog, email: string) => {
18 | posthog.setPersonProperties({ email });
19 | };
20 |
21 | export function onVideoPlay(
22 | posthog: PostHog,
23 | e: React.SyntheticEvent<HTMLVideoElement, Event>
24 | ) {
25 | recordEvent(posthog, "video.play", {
26 | category: "Video played",
27 | success: true,
28 | });
29 | }
30 |
31 | export function onVideoError(
32 | posthog: PostHog,
33 | e: React.SyntheticEvent<HTMLVideoElement, Event>
34 | ) {
35 | recordEvent(posthog, "video.error", {
36 | category: "Video playback error",
37 | success: false,
38 | errorMessage: e.toString(),
39 | });
40 | }
41 |
--------------------------------------------------------------------------------
/src/instrumentation.ts:
--------------------------------------------------------------------------------
1 | import * as Sentry from '@sentry/nextjs';
2 |
3 | const edgeConfig = {
4 | dsn: "https://5e1c9ebbaa5b3f636fc63ba5003412d2@o4506345201532928.ingest.us.sentry.io/4506345292693504",
5 |
6 | // Adjust this value in production, or use tracesSampler for greater control
7 | tracesSampleRate: 1,
8 |
9 | // Setting this option to true will print useful information to the console while you're setting up Sentry.
10 | debug: false,
11 | };
12 |
13 | const serverConfig = {
14 | dsn: "https://5e1c9ebbaa5b3f636fc63ba5003412d2@o4506345201532928.ingest.us.sentry.io/4506345292693504",
15 |
16 | // Adjust this value in production, or use tracesSampler for greater control
17 | tracesSampleRate: 1,
18 |
19 | // Setting this option to true will print useful information to the console while you're setting up Sentry.
20 | debug: false,
21 |
22 | // Uncomment the line below to enable Spotlight (https://spotlightjs.com)
23 | // spotlight: process.env.NODE_ENV === 'development',
24 |
25 | };
26 |
27 | export async function register() {
28 | if (process.env.NEXT_RUNTIME === 'nodejs') {
29 | Sentry.init(serverConfig);
30 | } else if (process.env.NEXT_RUNTIME === 'edge') {
31 | Sentry.init(edgeConfig);
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/navigator.d.ts:
--------------------------------------------------------------------------------
1 | // From: https://github.com/lukewarlow/user-agent-data-types/blob/5eafe444181f3d90265c3a939c79f2dae0100f22/index.d.ts
2 |
3 | // WICG Spec: https://wicg.github.io/ua-client-hints
4 |
5 | type AutoplayMediaType = 'mediaelement' | 'audiocontext';
6 | type AutoplayPolicy = 'allowed' | 'allowed-muted' | 'disallowed';
7 |
8 | declare interface Navigator extends NavigatorUA {
9 | getAutoplayPolicy: (type: AutoplayMediaType) => AutoplayPolicy;
10 | }
11 | declare interface WorkerNavigator extends NavigatorUA {}
12 |
13 | // https://wicg.github.io/ua-client-hints/#navigatorua
14 | declare interface NavigatorUA {
15 | readonly userAgentData?: NavigatorUAData;
16 | }
17 |
18 | // https://wicg.github.io/ua-client-hints/#dictdef-navigatoruabrandversion
19 | interface NavigatorUABrandVersion {
20 | readonly brand: string;
21 | readonly version: string;
22 | }
23 |
24 | // https://wicg.github.io/ua-client-hints/#dictdef-uadatavalues
25 | interface UADataValues {
26 | readonly brands?: NavigatorUABrandVersion[];
27 | readonly mobile?: boolean;
28 | readonly platform?: string;
29 | readonly architecture?: string;
30 | readonly bitness?: string;
31 | readonly formFactor?: string[];
32 | readonly model?: string;
33 | readonly platformVersion?: string;
34 | /** @deprecated in favour of fullVersionList */
35 | readonly uaFullVersion?: string;
36 | readonly fullVersionList?: NavigatorUABrandVersion[];
37 | readonly wow64?: boolean;
38 | }
39 |
40 | // https://wicg.github.io/ua-client-hints/#dictdef-ualowentropyjson
41 | interface UALowEntropyJSON {
42 | readonly brands: NavigatorUABrandVersion[];
43 | readonly mobile: boolean;
44 | readonly platform: string;
45 | }
46 |
47 | // https://wicg.github.io/ua-client-hints/#navigatoruadata
48 | interface NavigatorUAData extends UALowEntropyJSON {
49 | getHighEntropyValues(hints: string[]): Promise<UADataValues>;
50 | toJSON(): UALowEntropyJSON;
51 | }
52 |
--------------------------------------------------------------------------------
/src/utils.ts:
--------------------------------------------------------------------------------
1 | import { type ClassValue, clsx } from "clsx"
2 | import { twMerge } from "tailwind-merge"
3 |
4 | export function cn(...inputs: ClassValue[]) {
5 | return twMerge(clsx(inputs))
6 | }
7 |
--------------------------------------------------------------------------------
/styles.css:
--------------------------------------------------------------------------------
1 | @tailwind base;
2 | @tailwind components;
3 | @tailwind utilities;
4 | @import url('./styles/global.css');
5 |
6 | @layer base {
7 | :root {
8 | --background: 0 0% 100%;
9 | --foreground: 222.2 84% 4.9%;
10 |
11 | --card: 0 0% 100%;
12 | --card-foreground: 222.2 84% 4.9%;
13 |
14 | --popover: 0 0% 100%;
15 | --popover-foreground: 222.2 84% 4.9%;
16 |
17 | --primary: 222.2 47.4% 11.2%;
18 | --primary-foreground: 210 40% 98%;
19 |
20 | --secondary: 210 40% 96.1%;
21 | --secondary-foreground: 222.2 47.4% 11.2%;
22 |
23 | --muted: 210 40% 96.1%;
24 | --muted-foreground: 215.4 16.3% 46.9%;
25 |
26 | --accent: 210 40% 96.1%;
27 | --accent-foreground: 222.2 47.4% 11.2%;
28 |
29 | --destructive: 0 84.2% 60.2%;
30 | --destructive-foreground: 210 40% 98%;
31 |
32 | --border: 214.3 31.8% 91.4%;
33 | --input: 214.3 31.8% 91.4%;
34 | --ring: 222.2 84% 4.9%;
35 |
36 | --radius: 0.5rem;
37 |
38 | --chart-1: 12 76% 61%;
39 | --chart-2: 173 58% 39%;
40 | --chart-3: 197 37% 24%;
41 | --chart-4: 43 74% 66%;
42 | --chart-5: 27 87% 67%;
43 | }
44 |
45 | .dark {
46 | --background: 222.2 84% 4.9%;
47 | --foreground: 210 40% 98%;
48 |
49 | --card: 222.2 84% 4.9%;
50 | --card-foreground: 210 40% 98%;
51 |
52 | --popover: 222.2 84% 4.9%;
53 | --popover-foreground: 210 40% 98%;
54 |
55 | --primary: 210 40% 98%;
56 | --primary-foreground: 222.2 47.4% 11.2%;
57 |
58 | --secondary: 217.2 32.6% 17.5%;
59 | --secondary-foreground: 210 40% 98%;
60 |
61 | --muted: 217.2 32.6% 17.5%;
62 | --muted-foreground: 215 20.2% 65.1%;
63 |
64 | --accent: 217.2 32.6% 17.5%;
65 | --accent-foreground: 210 40% 98%;
66 |
67 | --destructive: 0 62.8% 30.6%;
68 | --destructive-foreground: 210 40% 98%;
69 |
70 | --border: 0, 0%, 100%, 0.1;
71 | --input: 217.2 32.6% 17.5%;
72 | --ring: 212.7 26.8% 83.9%;
73 |
74 | --chart-1: 220 70% 50%;
75 | --chart-2: 160 60% 45%;
76 | --chart-3: 30 80% 55%;
77 | --chart-4: 280 65% 60%;
78 | --chart-5: 340 75% 55%;
79 | }
80 | }
81 |
82 | @layer base {
83 | * {
84 | @apply border-border;
85 | }
86 | body {
87 | @apply bg-background text-foreground;
88 | }
89 | }
90 |
--------------------------------------------------------------------------------
/styles/global.css:
--------------------------------------------------------------------------------
1 | :root {
2 | --gradient-blue: linear-gradient(100deg, #027dfd 26.96%, #92ebfe 109.1%);
3 | --nextra-banner-height: 4rem;
4 | }
5 |
6 | h1,
7 | h2,
8 | h3,
9 | h4,
10 | h5,
11 | h6 {
12 | font-family: var(--font-poppins), sans-serif;
13 | }
14 |
15 | body,
16 | html {
17 | max-width: 100%;
18 | overflow-x: hidden;
19 | }
20 |
21 | pre, code {
22 | font-family: var(--font-berkeley-mono), monospace;
23 | }
24 |
25 | /* Hide the word wrap and copy buttons which are overlaid on pre blocks for small screens */
26 | @media screen and (max-width: 768px) {
27 | pre + div > button {
28 | display: none;
29 | }
30 | }
31 |
32 | .banner {
33 | text-wrap: wrap; /* Safari fallback */
34 | text-wrap: pretty;
35 | }
--------------------------------------------------------------------------------
/tailwind.config.js:
--------------------------------------------------------------------------------
1 | /** @type {import('tailwindcss').Config} */
2 | module.exports = {
3 | darkMode: 'selector',
4 | content: [
5 | './pages/**/*.{md,mdx}',
6 | './components/**/*.{js,ts,jsx,tsx}',
7 | ],
8 | prefix: "",
9 | theme: {
10 | container: {
11 | center: true,
12 | padding: "2rem",
13 | screens: {
14 | "2xl": "1400px",
15 | },
16 | },
17 | fontFamily: {
18 | mono: ['var(--font-berkeley-mono)', 'monospace'],
19 | },
20 | extend: {
21 | flex: {
22 | '2': '2 2 0%',
23 | '3': '3 3 0%',
24 | },
25 | colors: {
26 | border: "hsl(var(--border))",
27 | input: "hsl(var(--input))",
28 | ring: "hsl(var(--ring))",
29 | background: "hsl(var(--background))",
30 | foreground: "hsl(var(--foreground))",
31 | primary: {
32 | DEFAULT: "hsl(var(--primary))",
33 | foreground: "hsl(var(--primary-foreground))",
34 | },
35 | secondary: {
36 | DEFAULT: "hsl(var(--secondary))",
37 | foreground: "hsl(var(--secondary-foreground))",
38 | },
39 | destructive: {
40 | DEFAULT: "hsl(var(--destructive))",
41 | foreground: "hsl(var(--destructive-foreground))",
42 | },
43 | muted: {
44 | DEFAULT: "hsl(var(--muted))",
45 | foreground: "hsl(var(--muted-foreground))",
46 | },
47 | accent: {
48 | DEFAULT: "hsl(var(--accent))",
49 | foreground: "hsl(var(--accent-foreground))",
50 | },
51 | popover: {
52 | DEFAULT: "hsl(var(--popover))",
53 | foreground: "hsl(var(--popover-foreground))",
54 | },
55 | card: {
56 | DEFAULT: "hsl(var(--card))",
57 | foreground: "hsl(var(--card-foreground))",
58 | },
59 | },
60 | borderRadius: {
61 | lg: "var(--radius)",
62 | md: "calc(var(--radius) - 2px)",
63 | sm: "calc(var(--radius) - 4px)",
64 | },
65 | keyframes: {
66 | "accordion-down": {
67 | from: { height: "0" },
68 | to: { height: "var(--radix-accordion-content-height)" },
69 | },
70 | "accordion-up": {
71 | from: { height: "var(--radix-accordion-content-height)" },
72 | to: { height: "0" },
73 | },
74 | },
75 | animation: {
76 | "accordion-down": "accordion-down 0.2s ease-out",
77 | "accordion-up": "accordion-up 0.2s ease-out",
78 | },
79 | },
80 | },
81 | plugins: [require("tailwindcss-animate")],
82 | }
--------------------------------------------------------------------------------
/theme.config.tsx:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { DocsThemeConfig, useConfig } from "nextra-theme-docs";
3 | import { useRouter } from "next/router";
4 | import Logo from "@components/Logo";
5 | import Footer from "./components/Footer";
6 | import { Button } from "./components/ui/button";
7 |
8 | const config: DocsThemeConfig = {
9 | logo: <Logo />,
10 | logoLink: "/",
11 | project: {
12 | link: "https://github.com/celest-dev/celest",
13 | },
14 | chat: {
15 | link: "https://discord.gg/KtMAfSDXGQ",
16 | },
17 | darkMode: true,
18 | docsRepositoryBase: "https://github.com/celest-dev/website",
19 | useNextSeoProps() {
20 | return { titleTemplate: "%s | Celest" };
21 | },
22 | head() {
23 | const router = useRouter();
24 | const { asPath } = router;
25 |
26 | const url = `https://www.celest.dev${asPath}`;
27 |
28 | const { frontMatter, title: defaultTitle } = useConfig();
29 | const title = frontMatter.title ?? defaultTitle;
30 | const fullTitle = `${title} | Celest`;
31 |
32 | const description = frontMatter.description || "The Flutter cloud platform";
33 |
34 | let ogImage = "https://www.celest.dev/api/og";
35 | if (asPath !== "/") {
36 | ogImage += `?title=${encodeURIComponent(title)}`;
37 | }
38 |
39 | return (
40 | <>
41 | <link
42 | rel="apple-touch-icon"
43 | sizes="180x180"
44 | href="/apple-touch-icon.png"
45 | />
46 | <link
47 | rel="icon"
48 | type="image/png"
49 | sizes="32x32"
50 | href="/favicon-32x32.png"
51 | />
52 | <link
53 | rel="icon"
54 | type="image/png"
55 | sizes="16x16"
56 | href="/favicon-16x16.png"
57 | />
58 | <link rel="icon" type="image/x-icon" href="/favicon.ico" />
59 | <title>{fullTitle}
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 | );
73 | },
74 | search: {
75 | placeholder: "Search the docs...",
76 | },
77 | footer: {
78 | text: Footer,
79 | },
80 | sidebar: {
81 | defaultMenuCollapseLevel: 1,
82 | },
83 | };
84 |
85 | export default config;
86 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "es5",
4 | "lib": ["dom", "dom.iterable", "esnext"],
5 | "allowJs": true,
6 | "skipLibCheck": true,
7 | "strict": false,
8 | "forceConsistentCasingInFileNames": true,
9 | "noEmit": true,
10 | "incremental": true,
11 | "esModuleInterop": true,
12 | "module": "esnext",
13 | "moduleResolution": "node",
14 | "resolveJsonModule": true,
15 | "isolatedModules": true,
16 | "jsx": "preserve",
17 | "paths": {
18 | "@/*": ["./*"],
19 | "@components/*": ["./components/*"]
20 | }
21 | },
22 | "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
23 | "exclude": ["node_modules"]
24 | }
25 |
--------------------------------------------------------------------------------