Skip to content

Commit

Permalink
docs: update developer-guide.md (#605)
Browse files Browse the repository at this point in the history
Submit a pull request for this project.

<!-- If you have an Issue that related to this Pull Request, you can
copy this Issue's description -->

# Why? 
<!-- 
> Related to which issue?
> Why we need this pull request?
> What is the user story for this pull request? 
-->

I encounter many duplicate community users problems.
Write some to here for the future.


# What?
<!-- 
> Can you describe this feature in detail?
> Who can benefit from it? 
-->

Add more questions and answer to developer guide.

# How?
<!-- 
> Do you have a simple description of how this pull request is
implemented?
-->

Refactor the developer guide, and add more questions on it.
  • Loading branch information
mr-kelly committed Mar 22, 2023
1 parent 33d16f3 commit 1ae27e1
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions docs/contribute/developer-guide.md
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?




0 comments on commit 1ae27e1

Please sign in to comment.