feat: add README.md
This commit is contained in:
parent
7c8c1cabcb
commit
5deedf4cf0
|
@ -0,0 +1,4 @@
|
|||
# Contributing to answer
|
||||
## Coding and documentation Style
|
||||
|
||||
## Submitting Modifications
|
59
README.md
59
README.md
|
@ -1,35 +1,38 @@
|
|||
# answer
|
||||

|
||||
|
||||
问答社区主项目代码
|
||||
# Answer - Simple Q&A Community
|
||||
|
||||
# Dependence
|
||||
github.com/segmentfault/pacman
|
||||
* config-file `viper` https://github.com/spf13/viper
|
||||
* web `gin` https://gin-gonic.com/zh-cn/
|
||||
* log `zap` https://github.com/uber-go/zap
|
||||
* orm `xorm` https://xorm.io/zh/
|
||||
* redis `go-redis` https://github.com/go-redis/redis
|
||||
[](https://github.com/segmentfault/answer/blob/master/LICENSE)
|
||||
[](https://golang.org/)
|
||||
[](https://reactjs.org/)
|
||||
|
||||
# module
|
||||
- email github.com/jordan-wright/email
|
||||
- session github.com/gin-contrib/sessions
|
||||
- Captcha github.com/mojocn/base64Captcha
|
||||
## What is Answer?
|
||||
This is a minimalist open source Q&A community. Users can post questions and others can answer them.
|
||||

|
||||
|
||||
# Run
|
||||
```
|
||||
cd cmd
|
||||
export GOPRIVATE=git.backyard.segmentfault.com
|
||||
go mod tidy
|
||||
./dev.sh
|
||||
## Why?
|
||||
- Help companies build knowledge and Q&A communities better and faster.
|
||||
|
||||
## Features
|
||||
- Produce knowledge by asking and answering questions.
|
||||
- Maintain knowledge by voting and working together.
|
||||
|
||||
## Quick start
|
||||
### Running with docker-compose
|
||||
```bash
|
||||
mkdir answer && cd answer
|
||||
wget https://github.com/segmentfault/answer/releases/latest/download/docker-compose.yaml
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
# pprof
|
||||
For more information you can see [INSTALL.md](./INSTALL.md)
|
||||
|
||||
```
|
||||
# Installation dependency
|
||||
go get -u github.com/google/pprof
|
||||
brew install graphviz
|
||||
```
|
||||
```
|
||||
pprof -http :8082 http://XXX/debug/pprof/profile\?seconds\=10
|
||||
```
|
||||
## Contributing
|
||||
|
||||
Contributions are always welcome!
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for ways to get started.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](https://github.com/segmentfault/answer/blob/master/LICENSE)
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 118 KiB |
Binary file not shown.
After Width: | Height: | Size: 9.6 KiB |
Loading…
Reference in New Issue