90 lines
4.2 KiB
Markdown
90 lines
4.2 KiB
Markdown
<h1 align="center" style="border-bottom: none">AppFlowy Web<br>
|
|
⭐️ The Open Source Notion Alternative ⭐️
|
|
</h1>
|
|
<p align="center"> Use AppFlowy right in <a href="https://www.appflowy.com">your browser</a><br>
|
|
</p>
|
|
|
|
|
|
<p align="center">
|
|
Bring projects, wikis, and teams together with AI
|
|
</p>
|
|
<p align="center">
|
|
<a href="http://www.appflowy.com"><b>Web</b></a> •
|
|
<a href="https://appflowy.io/download">Apps</a> •
|
|
<a href="https://discord.gg/9Q2xaN37tV"><b>Discord</b></a> •
|
|
<a href="https://twitter.com/appflowy"><b>Twitter</b></a> •
|
|
<a href="https://www.reddit.com/r/appflowy/"><b>Reddit</b></a> •
|
|
<a href="https://forum.appflowy.io/"><b>Forum</b></a>
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 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
|
|
- Write beautiful documents with rich content types
|
|
- Add a Quick Note to jot down lists, ideas, or to-dos
|
|
- Invite members to your workspace for seamless collaboration
|
|
- Create multiple public and private spaces to better organize your content
|
|
|
|
## AppFlowy Web roadmap
|
|
>Features listed below are available in AppFlowy desktop and mobile applications (<a href="https://appflowy.io/download">Download</a>).
|
|
|
|
Q1 2025:
|
|
- Templates
|
|
- Favorite pages
|
|
- Import and export markdown files
|
|
- More document features incl. simple table and column layout
|
|
- AI Chat and AI Writer
|
|
|
|
## Installation
|
|
### 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 <a href="https://appflowy.com/docs/self-host-appflowy-overview">deployment guide</a> to get started.
|
|
Join our <a href="https://discord.gg/FFmDE99bgA">Discord</a> server to get help!
|
|
|
|
## Built with 🛠️
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Development
|
|
### Pre-requisite
|
|
AppFlowy Cloud must be running and accessible by AppFlowy Web. If you alredy have AppFlowy Cloud running, you can skip this step.
|
|
|
|
For local development, please follow the steps below:
|
|
1. Install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
|
|
2. Clone the AppFlowy Cloud repository.
|
|
3. Copy deploy.env to .env, then run `docker-compose up -d`.
|
|
4. The AppFlowy Cloud API should be running on localhost:80, and allow CORS from localhost:3000 by default.
|
|
5. Setup at least one sign in method: SMTP for magic link, or using an OAuth provider. Refer to AppFlowy Cloud repository for more details.
|
|
|
|
### Running AppFlowy Web Locally
|
|
1. Copy .development.env to .env. The default value assumes that AppFlowy Cloud is deployed on localhost. If not, please update the value of the API endpoints.
|
|
2. Make sure `npm` has been installed on your dev environment, then run the following:
|
|
```
|
|
# npm install pnpm@8.5.0
|
|
pnpm install
|
|
|
|
pnpm run dev
|
|
```
|
|
|
|
Open your browser to visit localhost:3000
|
|
|
|
## License
|
|
Distributed under the AGPLv3 License. See [`LICENSE.md`](https://github.com/AppFlowy-IO/AppFlowy-Web/blob/main/LICENSE) for
|
|
more information.
|