deliri / satellity Goto Github PK

Satellity is a 100% open source forum, written in Go. Now only forum part is online, 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!

Satellity is a still a PRE-ALPHA version. Please don't use it in production!!

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. Go version go1.12.5 darwin/amd64
2. postgres (PostgreSQL) 11.1
3. react ^16.8.4

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. cd ./internal, copy config/config.example to config/config.yaml. Replace config with yours.
2. Prepare and start database, the database schema under ./internal/models/schema.sql, how to install postgresql.
3. cd ./ && make install && make build && ./bin/satellity 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