Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update developer-guide.md #605

Merged
merged 1 commit into from
Mar 22, 2023
Merged

docs: update developer-guide.md #605

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 30 additions & 3 deletions docs/contribute/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ sudo apt install make
```


## Build Tool
## What Build Tool we use?

We use `make` as our centric build tool entry that drives other build tool like `gradle` / `npm` / `yarn`.

Expand All @@ -87,7 +87,7 @@ make



## Start Development Environment
## How to start development environment?

APITable consists of 3 processes:

Expand Down Expand Up @@ -120,10 +120,37 @@ make run # enter 3



## IDE
## What IDE should you use?

We recommend you use `Visual Studio Code` or `Intellij IDEA` for your IDE.

APITable have prepared these two IDE's debug configs.

Just open APITable's root directory with IDE.



## How to configurate the SMTP server?

By default, APITable doesn't configure the SMTP server, which means you cannot invite users since it require the email sending feature.


## Performance problem under macOS M1 docker run?

## Where is the API documentation?

## How to set the limitation of widget quantity in dashboard? (Default 30)

## Can I improve the API query rate limit? (Default 5)
Yes, You can configure it in the .env file.
But, we recommend you don't set it too large due to the performance problem.

## Can I improve the API query batch tasks? (Default 10)

## How to upgrade to the newest release version?

## How to change the default 80 port?