From 664712bc3900835c8b3eeb2f9faac137702692f3 Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:12:08 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..cf257ab --- /dev/null +++ b/README.en.md @@ -0,0 +1,68 @@ + + logo + + +# Apache Answer - Build Q&A platform + +A Q&A platform software for teams at any scales. Whether it’s a community forum, help center, or knowledge management platform, you can always count on Answer. + +To learn more about the project, visit [answer.apache.org](https://answer.apache.org). + +[![LICENSE](https://img.shields.io/github/license/apache/answer)](https://github.com/apache/answer/blob/main/LICENSE) +[![Language](https://img.shields.io/badge/language-go-blue.svg)](https://golang.org/) +[![Language](https://img.shields.io/badge/language-react-blue.svg)](https://reactjs.org/) +[![Go Report Card](https://goreportcard.com/badge/github.com/apache/answer)](https://goreportcard.com/report/github.com/apache/answer) +[![Discord](https://img.shields.io/badge/discord-chat-5865f2?logo=discord&logoColor=f5f5f5)](https://discord.gg/Jm7Y4cbUej) + +## Screenshots + +![screenshot](docs/img/screenshot.png) + +## Quick start + +### Running with docker + +```bash +docker run -d -p 9080:80 -v answer-data:/data --name answer apache/answer:2.0.2 +``` + +For more information, see [Installation](https://answer.apache.org/docs/installation). + +### Plugins + +Answer provides a plugin system for developers to create custom plugins and expand Answer’s features. You can find the [plugin documentation here](https://answer.apache.org/community/plugins). + +We value your feedback and suggestions to improve our documentation. If you have any comments or questions, please feel free to contact us. We’re excited to see what you can create using our plugin system! + +You can also check out the [plugins here](https://answer.apache.org/plugins). + +## Building from Source + +### Prerequisites + +- Golang >= 1.23 +- Node.js >= 20 +- pnpm >= 9 +- [mockgen](https://github.com/uber-go/mock?tab=readme-ov-file#installation) >= 0.6.0 +- [wire](https://github.com/google/wire/) >= 0.5.0 + +### Build + +```bash +# Install wire and mockgen for building. You can run `make check` to check if they are installed. +$ make generate +# Install frontend dependencies and build +$ make ui +# Install backend dependencies and build +$ make build +``` + +## Contributing + +Contributions are always welcome! + +See [CONTRIBUTING](https://answer.apache.org/community/contributing) for ways to get started. + +## License + +[Apache License 2.0](https://github.com/apache/answer/blob/main/LICENSE)