README-en.md

Fun

(have)Fun with Serverless

中文文档

Fun is a development tool for serverless applications. It can help you to efficiently arrange cloud resources such as Function Compute, API Gateway, Log Service and so on. You can use it to develop，build and deploy FC by describing relative resources in a template.yml file.

If you want to use the old syntax, please refer to README.md.

Get Started

As a command-line tool, Fun has built-in subcommands such as config, local, deploy, and so on.

The config subcommand can be used to configure fun, the local subcommand can be used to run the debugging function locally, and the deploy subcommand can publish your resources.

We have prepared a series of tutorials to help you use the Fun tool more easily:

• Installation: Learn how to install Fun on Mac, Linux or Windows.
• Getting Started: The basic usage of Fun is introduced with a simple example.
• Series articles:
  • Custom templates: Articles on how to quickly build a project using fun init.
    • 开发函数计算的正确姿势 —— 使用 Fun Init 初始化项目: Introduced the basic usage of fun init.
    • Fun Init 自定义模板: Introduce how to develop a fun init template.
    • Third-party templates: Third-party templates that can be quickly initialized directly by fun init [repo].
      • puppeteer 模板项目: Screenshot service based on puppeteer deployment on Function Compute service.
      • 函数计算 R 语言模板项目：Template project for R language, can be used directly.
  • Dependences installation: Articles on how to use fun install to quickly install dependencies.
    • 开发函数计算的正确姿势 —— 安装第三方依赖: introduce the basic usage of fun install.
    • 函数运行环境系统动态链接库版本太低？函数计算 fun 神助力分忧解难: Introduce how to use fun install to upgrade the system Dynamic-link libraries.
    • How fun install works: Recommended ways for dependences installation before fun install was introduced. It is now recommended to use fun install first. The following article can be used to understand the principle of fun install in order to use fun install better.
      • Installing a Dependency Library for Function Compute：Summarized the methods of each language dependent installation.
      • Using Python to Connect Function Compute to SQL Server: Introduce how to use the fc-docker to install the pymssql library. The idea introduced in this article is similar to the underlying implementation of fun install.
      • 手把手教您将 libreoffice 移植到函数计算平台: Introduce how to use Fc-docker to deploy libreoffice to Function compute.
  • Running and debugging locally: A series on how to run locally, debug functions, and tips on troubleshooting related issues.
    • Guidelines for Function Compute Development - Use Fun Local for Local Running and Debugging: introduce the basic usage of Fun Local.
    • 开发函数计算的正确姿势 —— Http Trigger 本地运行调试: Demonstrates how to run and debug Http Trigger functions locally.
    • 开发函数计算的正确姿势 —— 本地运行、调试、发布 NAS 函数: Demonstrates how to run and debug functions configured with NAS services locally.
    • 开发函数计算的正确姿势 —— Api 本地运行调试: Demonstrates how to run and debug functions locally through the API.
  • Deploy: Articles on how to quickly deploy Function Compute.
    • 开发函数计算的正确姿势 —— 部署 API 网关: Introduce how to deploy the API Gateway + Function Compute application.
  • Fun in action:
    • Guidelines for Function Compute Development - Crawler: How to use the Fun tool to develop a Serverless application from scratch.
    • Guidelines for Function Compute Development - Troubleshoot Timeout Issues: Demonstrates how to solve a series of bugs and introduces the tricks of debug.
    • 开发函数计算的正确姿势 —— 开发 WordPress 应用: Demonstrates how to develop and debug a WordPress web application locally.
    • 开发函数计算的正确姿势 —— 开发 NAS 文件管理应用: Demonstrates how to develop and debug a NAS file manager web application locally.
    • 开发函数计算的正确姿势——网页截图服务: Introduce how to use Function Compute to quickly develop web page screenshot service.
    • 五分钟教你如何用函数计算部署钉钉群发机器人：Introduce how to use the Function Compute to quickly build a DingTalk robot.
    • 五分钟上线——函数计算 Word 转 PDF 云服务: ：Introduce how to migrate ibreoffice to Function Compute in order to convert word to pdf.
    • 用函数计算搭建微服务——云客服访客名片: Introduce how to use the Function Compute to build a micro service of visitor card.
    • 三分钟学会如何在函数计算中使用 puppeteer: Introduce how to use puppeteer in Function Compute.
    • 函数计算部署机器学习遇到的问题和解法：Some problems that may be encountered when machine learning is deployed to Function Compute and some solutions to related problems.
• Specification: Introduces the syntax of the fun's template.yml file.
• FAQ: Frequently asked questions and answers when using fun.
• More Examples

References

• 以函数计算作为 API 网关后端服务
• 函数计算
• API Gateway
• Fun 发布 2.0 新版本啦
• 函数计算工具链新成员 —— Fun Local 发布啦
• 三十分钟快速搭建 serverless 网盘服务
• Fc Docker

License

The MIT License