Skip to content

Commit

Permalink
docs: update readme & changelog (#580)
Browse files Browse the repository at this point in the history
  • Loading branch information
maslow authored Dec 24, 2022
1 parent 17f7606 commit 0051a8a
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 23 deletions.
60 changes: 59 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,62 @@
# [](https://github.com/maslow/laf/compare/v1.0.0-alpha.0...v) (2022-12-13)
# [](https://github.com/maslow/laf/compare/v1.0.0-alpha.2...v) (2022-12-24)


### Bug Fixes

* **server:** add policy service to module provider ([#576](https://github.com/maslow/laf/issues/576)) ([7911ba0](https://github.com/maslow/laf/commit/7911ba0a0475804982f5d1bb050346f647657b5a))
* **server:** fix build error in policy service ([#575](https://github.com/maslow/laf/issues/575)) ([88ae17d](https://github.com/maslow/laf/commit/88ae17d718f37def429b17e141bd0137c4e33ce9))
* **server:** support array input param for adding deps ([#577](https://github.com/maslow/laf/issues/577)) ([a7c0dc8](https://github.com/maslow/laf/commit/a7c0dc893305248276d33abc359758b95f25640f))
* **web:** fix to use new function debug token header & url ([99cf35c](https://github.com/maslow/laf/commit/99cf35c504383af67c947ea74f9e57b24f405820))


### Features

* **runtime:** support interceptor function [#341](https://github.com/maslow/laf/issues/341) ([#579](https://github.com/maslow/laf/issues/579)) ([17f7606](https://github.com/maslow/laf/commit/17f7606642c511e85824537a97c4ca3b502fb561))
* **sdk:** add cloud sdk package ([c98aaec](https://github.com/maslow/laf/commit/c98aaec086ae023da544ca7b23068464fc29d13a))
* **server:** implement cron trigger schema & crud apis ([#578](https://github.com/maslow/laf/issues/578)) ([3f6927c](https://github.com/maslow/laf/commit/3f6927c34e5526c16c41c68c9d4fae3d823106be))
* **server:** implement policy schema & apis ([#574](https://github.com/maslow/laf/issues/574)) ([0d1d090](https://github.com/maslow/laf/commit/0d1d090d330bb33f89fa2f04c4f8476f6d68b30f))
* **web:** add app restart ([#571](https://github.com/maslow/laf/issues/571)) ([c53d76a](https://github.com/maslow/laf/commit/c53d76a4db1ddd2c6d49759f1b4c6f780933d447))
* **web:** add page cache when switch sidebar page ([#563](https://github.com/maslow/laf/issues/563)) ([c499afe](https://github.com/maslow/laf/commit/c499afeacf913d08b9ebb99cd9fc90d9812a5bad))



# [1.0.0-alpha.2](https://github.com/maslow/laf/compare/v1.0.0-alpha.1...v1.0.0-alpha.2) (2022-12-19)


### Bug Fixes

* **runtime:** update deps installation impl to new design ([#553](https://github.com/maslow/laf/issues/553)) ([cdda443](https://github.com/maslow/laf/commit/cdda44352ce0435efbc6782e291c7caa84c9376d))
* **web:** error when no function data ([#556](https://github.com/maslow/laf/issues/556)) ([8d2e4b6](https://github.com/maslow/laf/commit/8d2e4b6ed6ba3d17b8cd7e9ac4a55c5cea8fff1b))
* **web:** fix function compile res data error ([#549](https://github.com/maslow/laf/issues/549)) ([9d6f8b0](https://github.com/maslow/laf/commit/9d6f8b036006f8136dc67795ed66d4d11763059e))
* **web:** pagination ts error ([#560](https://github.com/maslow/laf/issues/560)) ([3380690](https://github.com/maslow/laf/commit/3380690041930a7bc0181be2b16ea3b26b643bfb))


### Features

* **server:** add app restart api & handler ([#558](https://github.com/maslow/laf/issues/558)) ([5764029](https://github.com/maslow/laf/commit/57640292a5e1d46618eccdb22ab00d70f7f87874))
* **server:** add dependency module & apis ([#552](https://github.com/maslow/laf/issues/552)) ([24a497d](https://github.com/maslow/laf/commit/24a497d26859c754bcb6d161ea8c5a1acec9de12))
* **web:** add func deploy confirm & code diff info ([#550](https://github.com/maslow/laf/issues/550)) ([682dcc5](https://github.com/maslow/laf/commit/682dcc528af18951c689a0c4e9bc80904f608196))
* **web:** impl function logs page ([#559](https://github.com/maslow/laf/issues/559)) ([97c4728](https://github.com/maslow/laf/commit/97c4728c846ca4c8725e4f56edfae3fd535dd7e2))



# [1.0.0-alpha.1](https://github.com/maslow/laf/compare/v1.0.0-alpha.0...v1.0.0-alpha.1) (2022-12-15)


### Bug Fixes

* **core:** fix gateway bucket name issue & minio deploy domain config ([#537](https://github.com/maslow/laf/issues/537)) ([b08b4e2](https://github.com/maslow/laf/commit/b08b4e2e5c661fee77846bcd6b77022d96bf714a))
* **runtime:** impv runtime logging struct; add func logs api ([#538](https://github.com/maslow/laf/issues/538)) ([c9d2292](https://github.com/maslow/laf/commit/c9d22925cd4222a5088b388ff068fad8b2644a9b))
* **server:** fix compile function api params schema error ([#540](https://github.com/maslow/laf/issues/540)) ([37c049c](https://github.com/maslow/laf/commit/37c049ccff0dbcb9e0c66b967dfb9f87301341ba))
* **server:** fix prisma bin engine error in amd64 ([#547](https://github.com/maslow/laf/issues/547)) ([4c76333](https://github.com/maslow/laf/commit/4c7633302e78072881a3fdac708fb8e74eb00e58))
* **server:** func compile api response struct dismatch standard ([#543](https://github.com/maslow/laf/issues/543)) ([97de760](https://github.com/maslow/laf/commit/97de760e57820f6418e82fdb1c75f23ce61f0121))
* **web:** replace aws client sdk v3 with v2 ([#546](https://github.com/maslow/laf/issues/546)) ([3282894](https://github.com/maslow/laf/commit/328289416920ae0685ec2bd9f25fd937a8f01fb4))


### Features

* **web:** complete function compile ([#545](https://github.com/maslow/laf/issues/545)) ([7c712e8](https://github.com/maslow/laf/commit/7c712e86163117e97aee262fd4edf1bc9877f3d9))
* **web:** impl db crud; impl file crud; ([#542](https://github.com/maslow/laf/issues/542)) ([9782423](https://github.com/maslow/laf/commit/978242306449121c1e493e0e57136cee15850ae7)), closes [#535](https://github.com/maslow/laf/issues/535) [#536](https://github.com/maslow/laf/issues/536) [#537](https://github.com/maslow/laf/issues/537) [#538](https://github.com/maslow/laf/issues/538) [#539](https://github.com/maslow/laf/issues/539)



Expand Down
34 changes: 12 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@
- laf 是一个开源的 BaaS 开发平台(Backend as a Service)
- laf 是一个开箱即用的 serverless 开发平台
- laf 是一个集「函数计算」、「数据库」、「对象存储」等于一身的一站式开发平台
- laf 可以是开源版的腾讯云开发、开源版的 Google Firebase、开源版的 UniCloud
- laf 可以是开源版的腾讯云开发、开源版的 Google Firebase

[`laf`](https://github.com/labring/laf) 让每个开发团队都可以随时拥有一个自己的云开发平台!

## 🎉 `laf` 有什么

- 多应用管理,新建、启停应用,无需折腾服务器,一分钟上线应用
- 云函数,`laf` 提供的函数计算服务,可以快速的实现后端业务
- 云数据库,为应用开发提供开箱即用的数据库服务
- 云存储,为应用开发提供专业的文件对象存储服务,兼容 S3 和其他存储服务接口
- 云函数,提供的函数计算服务,可以快速的实现后端业务
- 云数据库,提供开箱即用的数据库服务
- 云存储,提供专业的文件对象存储服务,兼容 S3 和其他存储服务接口
- WebIDE,在线写代码,完善的类型提示、代码自动完成,像写博客一样写函数,随手发布上线!
- 静态托管,支持静态网站的托管,可以快速的上线静态网站,无需折腾 nginx
- Client Db,支持客户端使用 [laf-client-sdk](https://github.com/labring/laf/tree/main/packages/client-sdk) “直连”数据库,通过访问策略控制访问权限,极大程度提升应用开发效率
- Database Proxy,支持客户端使用 [laf-client-sdk](https://github.com/labring/laf/tree/main/packages/client-sdk) “直连”数据库,通过访问策略控制访问权限,极大程度提升应用开发效率
- WebSocket,应用支持长连接,业务无死角

可以通过下面的屏幕截图进一步了解 `laf`:
Expand Down Expand Up @@ -74,26 +74,19 @@
2. 后端开发者,可以从琐事中解放出来,专注于业务本身,提升开发效率

- `laf` 可以节约服务器运维、多环境部署和管理精力
- `laf` 可以让你告别配置、调试 nginx
- `laf` 可以让你告别「为每个项目手动部署数据库、安全顾虑等重复性工作」
- `laf` 可以让你告别「修改一次、发布半天」的重复繁琐的迭代体验
- `laf` 可以让你随时随地在 Web 上查看函数的运行日志,不必再连接服务器,费神费眼翻找
- `laf` 可以让你「像写博客一样写一个函数」,招之即来,挥之即去,随手发布!
- `laf` 让你告别配置、调试 nginx
- `laf` 让你告别「为每个项目手动部署数据库、安全顾虑等重复性工作」
- `laf` 让你告别「修改一次、发布半天」的重复繁琐的迭代体验
- `laf` 让你随时随地在 Web 上查看函数的运行日志,不必再连接服务器,费神费眼翻找
- `laf` 让你「像写博客一样写一个函数」,招之即来,挥之即去,随手发布!

3. 云开发用户,若你是微信云开发用户,你不仅可以获得更强大、快速的开发体验,还不被微信云开发平台锁定
3. 云开发用户,若你是其它厂商的云开发用户,你不仅可以获得更强大、快速的开发体验,还不被云厂商锁定

- 你可以为客户提供源码交付,为客户私有部署一套 `laf` + 你的云开发应用,而使用闭源的云开发服务,无法交付可独立运行的源码
- 你可以根据未来的需要,随时将自己的产品部署到自己的服务器上,`laf` 是开源免费的
- 你甚至可以修改、订制自己的云开发平台,`laf` 是开源的、高度可扩展的

4. Node.js 开发者,`laf` 是使用 Node.js 开发的,你可以把 `laf` 当成一个更方便的 Node.js 开发平台 or 框架

- 你可以在线编写、调试函数,不用重启服务,一键发布即可用
- 你可以在线查看、检索函数调用日志
- 你可以不必折腾数据库、对象存储、nginx,随时随地让你的应用上线
- 你可以随手将一段 Node.js 代码上云,比如一段爬虫,一段监控代码,像写博客一样写 Node!

5. 独立开发者、初创创业团队, 节约成本,快速开始,专注业务
4. 独立开发者、创业团队, 节约成本,快速开始,专注业务
- 减少启动项目开发的流程,快速启动,缩短产品验证周期
- 极大程度提高迭代速度,随时应对变化,随时发布
- 专注于产品业务本身,快速推出最小可用产品(MVP),快速进行产品、市场验证
Expand Down Expand Up @@ -142,7 +135,6 @@
- `laf` 是每个开发者的“私人助理”,比如随时可以写一个定时发送短信、邮件通知的函数

6. 其它
- 有用户把 `laf` 云存储当网盘使用
- 有用户把 `laf` 应用当成一个日志服务器,收集客户端日志数据,使用云函数做分析统计
- 有用户用 `laf` 来跑爬虫,抓取三方新闻和咨讯等内容
- 有用户使用 `laf` 云函数做 webhook,监听 Git 仓库提交消息,推送到钉钉、企业微信群
Expand Down Expand Up @@ -175,8 +167,6 @@

![image](https://user-images.githubusercontent.com/7122237/193356979-d8e78594-f50d-4360-85c2-9c379341106d.png)

> 详见 [laf 架构说明文档](https://github.com/labring/laf/discussions/353)
## :point_right: Roadmap
- [**laf product key**](https://github.com/labring/laf/discussions/354)
- [**laf project roadmap**](https://github.com/orgs/labring/projects/5/views/1)
Expand Down

0 comments on commit 0051a8a

Please sign in to comment.