fresh README

The project's README from github.com/freshframework/fresh. As one markdown file: README.md.

Documentation | Getting started | API Reference

fresh

Fresh is a next generation web framework, built for speed, reliability, and simplicity.

Some stand-out features:

Island based client hydration for maximum interactivity.
Zero runtime overhead: no JS is shipped to the client by default.
No configuration necessary.
TypeScript support out of the box.
File-system routing à la Next.js.

📖 Documentation

The documentation is available on usefresh.dev.

🚀 Getting started

Install the latest Deno CLI version.

You can scaffold a new project by running the Fresh init script. To scaffold a project run the following:

deno run -Ar jsr:@fresh/init

Then navigate to the newly created project folder:

cd fresh-project

From within your project folder, start the development server using the deno task command:

deno task dev

Now open http://localhost:5173 in your browser to view the page. You make changes to the project source code and see them reflected in your browser.

To deploy the project to the live internet, you can use Deno Deploy:

Push your project to GitHub.
Create a Deno Deploy project.
Select your GitHub repository.
The project will be deployed to a public $project.$username.deno.net subdomain with no configuration necessary.

For a more in-depth getting started guide, visit the Getting Started page in the Fresh docs.

Contributing

We appreciate your help! To contribute, please read our contributing guideline.

Adding your project to the showcase

If you feel that your project would be helpful to other Fresh users, please consider putting your project on the showcase. However, websites that are just for promotional purposes may not be listed.

To take a screenshot, run the following command.

deno task screenshot [url] [your-app-name]

Then add your site to showcase.json, preferably with source code on GitHub, but not required.

Badges

[![Made with Fresh](https://usefresh.dev/fresh-badge.svg)](https://usefresh.dev)

<a href="https://usefresh.dev">
  <img
    width="197"
    height="37"
    src="https://usefresh.dev/fresh-badge.svg"
    alt="Made with Fresh"
  />
</a>

[![Made with Fresh](https://usefresh.dev/fresh-badge-dark.svg)](https://usefresh.dev)

<a href="https://usefresh.dev">
  <img
    width="197"
    height="37"
    src="https://usefresh.dev/fresh-badge-dark.svg"
    alt="Made with Fresh"
  />
</a>

Hashtags

Use the following hashtags in your social media posts that reference Fresh and as Topics in the About section of your GitHub repos that contain Fresh code. It will assure maximum visibility for your posts and code, and promote Fresh development ecosystem visibility.

#denofresh
#deno

Github repo Topics will not include the hash symbol.

Searching Database…

13.8K ·GitHub

这是什么？

Fresh 是一个面向 Deno 的新一代 Web 框架，注重速度、可靠性和简洁性。它采用基于孤岛（island）的客户端水合机制，因此默认不会向客户端发送任何 JS。

它是框架还是库？

它是一个完整的 Web 框架，提供类似 Next.js 的基于文件系统的路由，专门为在 Deno 上运行而构建，而不是 Node.js。

我该怎么让它跑起来？

安装 Deno CLI，运行 Fresh 的初始化脚本来搭建一个新项目，然后使用 deno task 命令启动开发服务器。

在试用之前，我需要先安装 Deno 吗？

需要，Fresh 依赖 Deno CLI；整个过程不涉及 Node.js 或 npm 步骤。

我需要先做什么配置吗？

不需要，Fresh 开箱即用，即使是部署也无需任何配置。

这里所说的“基于孤岛的客户端水合”到底是什么意思？

只有你标记出来的交互式组件（孤岛）会在客户端通过 JS 进行水合；页面的其余部分保持为静态 HTML，这也是为什么默认不会发送任何 JS。

Fresh 支持 TypeScript 吗？

支持，开箱即用地内置了 TypeScript 支持，无需额外配置。

在哪里可以看到用 Fresh 构建的真实项目？

有一个社区展示页面（showcase.json），开发者可以在这里添加自己基于 Fresh 的网站，最好同时附上 GitHub 上的源代码链接。

What are similar projects?

nuxt, framework, astro, vista, graphql, core, gatsby, razzle

Which topics is it in?

preact, server-side-rendering, deno, website, static-site-generator, full-stack, ssr, web-framework, sdk, cloud, web-development, framework

Creator: freshframework
Size: 45.3 MB
Stars: 13.8K
Updated: CommitJun 03 Release2.3.3Apr 28
Age: 5y
Commits · 90 Days