Skip to content

Latest commit

 

History

History
93 lines (75 loc) · 4.36 KB

README.md

File metadata and controls

93 lines (75 loc) · 4.36 KB

AppFlowy Web
⭐️ The Open Source Notion Alternative ⭐️

Use AppFlowy right in your browser

Bring projects, wikis, and teams together with AI

Web • Apps • Discord • Twitter • Reddit • Forum

appflowy_web appflowy_web_quickly_add_a_page appflowy_web_quick_note appflowy_web_quick_note_large appflowy_web_share

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 (Download).

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 appflowy.com—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 to get started. Join our Discord server to get help!

Built with 🛠️

React TypeScript Bun Nginx Docker

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 and Docker Compose
  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 [email protected]
pnpm install

pnpm run dev

Open your browser to visit localhost:3000

Deployment

Once AppFlowy Cloud has been setup, you can follow the deployment guide to deploy AppFlowy Web.

License

Distributed under the AGPLv3 License. See LICENSE.md for more information.