chk
/
AppFlowy-Web
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: add additional guideline for developer

This commit is contained in:
khorshuheng 2025-01-14 14:34:45 +08:00
parent 8fabf8ffd6
commit b21f560662
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.development.env Normal file
View File

@ -0,0 +1,3 @@
AF_BASE_URL=http://localhost
AF_GOTRUE_URL=http://localhost/gotrue
AF_WS_URL=ws://localhost/ws/v1

13
README.md
View File

@ -62,6 +62,19 @@ Join our <a href="https://discord.gg/FFmDE99bgA">Discord</a> server to get help!
![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
## Development ## 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 # npm install pnpm@8.5.0
pnpm install pnpm install