yianz / godiscourse Goto Github PK

GoDiscourse is a 100% open source, discourse-like forum written in Go. For demo, please visit https://live.godiscourse.com/. For feedback, you can submit issues or join our slack(https://bit.ly/2IV6LCW), Let's learn Go together!

1. Go version go1.12.1 darwin/amd64
2. postgres (PostgreSQL) 11.1
3. react ^16.8.4

1. REST API back-end written in Golang
2. React-based frontend
3. PostgreSQL, one of the best open source, flexible database
4. Social login (OAuth 2.0) only support Github now
5. JSON Web Tokens (JWT) are used for user authentication in the API
6. Markdown supported topic and comment
7. Model tested

1. ./ is back-end service, we followed golang-standards project-layout.
2. ./web is front-end service, contains React, Parcel and etc.
3. ./deploy contains example of deploy, nginx and systemd.

1. Set the following environment variables on your system:

export GODISCOURSE_URL=http://localhost
export GODISCOURSE_PORT=4000
export DB_USER=db user
export DB_PASSWORD=db pass
export DB_HOST=localhost
export DB_NAME=godiscourse_dev
export DB_PORT=5432
export ENV=test|development|production

2. cd ./internal, copy config/example.cfg to config/config.go. Replace config with yours.
3. Prepare and start database, the database schema under ./internal/models/schema.sql, how to install postgresql.
4. cd ./ && make install && make build && ./bin/godiscourse to start Golang server

1. cd ./web, copy .env.example to .env and .env.development and change the following fields:

   SITE_NAME=your site name
   API_HOST=http://localhost:4000 or production url
   GITHUB_CLIENT_ID=put your client id
   

2. run npm install to prepare front-end.

3. npm run dev and open http://localhost:1234

1. go to godiscourse folder
2. type docker-compose up