opensource/AppFlowy-Web
1
0
Fork 0
mirror of https://github.com/AppFlowy-IO/AppFlowy-Web.git synced 2025-11-29 02:38:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md batch 2

Browse Source 
Added more sections:
- Installation
- Built with
- Translations
- Use cases
- License
This commit is contained in:
Annie
2025-01-07 14:28:42 +08:00
committed by GitHub
parent f47af461f2
commit 19fcd77938
1 changed files with 34 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -24,18 +24,49 @@ Bring projects, wikis, and teams together with AI
![appflowy_web_quick_note_large](https://github.com/user-attachments/assets/5c633e60-6f34-454c-91db-236a1b78966a) ![appflowy_web_quick_note_large](https://github.com/user-attachments/assets/5c633e60-6f34-454c-91db-236a1b78966a)
![appflowy_web_share](https://github.com/user-attachments/assets/64b9955d-b11f-4aa1-b32b-ea79ea7f3566) ![appflowy_web_share](https://github.com/user-attachments/assets/64b9955d-b11f-4aa1-b32b-ea79ea7f3566)
## Use cases
- Build and maintain a knowledge base for your team
- Create and publish documentation for your customers and audience
- Write, publish, and manage content with AI
- Manage tasks and projects for yourself and your team
## Features ## Features
- Write beautiful documents with rich content types - Write beautiful documents with rich content types
- Add a Quick Note to jot down lists, ideas, or to-dos - Add a Quick Note to jot down lists, ideas, or to-dos
- Invite members to your workspace for seamless collaboration - Invite members to your workspace for seamless collaboration
- Create multiple public and private spaces to better organize your content - Create multiple public and private spaces to better organize your content
## AppFlowy Web Roadmap ## AppFlowy Web roadmap
Features listed below are available in AppFlowy desktop and mobile applications (<a href="https://appflowy.io/download">Download</a>). >Features listed below are available in AppFlowy desktop and mobile applications (<a href="https://appflowy.io/download">Download</a>).
Q1 2025:
- Search, publish pages, templates - Search, publish pages, templates
- Favorte pages - Favorte pages
- More document features incl. simple table and column layout - More document features incl. simple table and column layout
- AI Chat and AI Writer - AI Chat and AI Writer
## Installation ## Installation
WIP ### Cloud: we host AppFlowy for you
Sign up for a free account on <a href="https://appflowy.com">appflowy.com</a>—it's the fastest way to get started with AppFlowy without hassles
### Self-hosted: host AppFlowy on your own server
Take charge of your data; no vendor lock-in. Follow our deployment guide (WIP) to get started.
Join our <a href="https://discord.gg/FFmDE99bgA">Discord</a> server to get help!
## Built with 🛠️
![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![Bun](https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=white)
![Nginx](https://img.shields.io/badge/Nginx-009639?style=for-the-badge&logo=nginx&logoColor=white)
![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
## Translations 🌎🗺
[![translation badge](https://inlang.com/badge?url=github.com/AppFlowy-IO/AppFlowy)](https://inlang.com/editor/github.com/AppFlowy-IO/AppFlowy?ref=badge)
To add translations, you can manually edit the JSON translation files in `/frontend/resources/translations`, use
the [inlang online editor](https://inlang.com/editor/github.com/AppFlowy-IO/AppFlowy), or
run `npx inlang machine translate` to add missing translations.
## License
Distributed under the AGPLv3 License. See [`LICENSE.md`](https://github.com/AppFlowy-IO/AppFlowy-Web/blob/main/LICENSE) for
more information.