README
¶
sc2lover
sc2lover is a simple discussion board / forum web application.
Features
- REST API backend written in Go
- Vue.js-based frontend
- Two databases are supported:
- PostgreSQL
- MySQL
- Three file-storage backends are supported to store user-uploaded files (e.g. avatars):
- Local filesystem
- Google Cloud Storage
- Amazon S3
- Social login (OAuth 2.0) via three providers:
- Github
- BattleNet (CN)
- JSON Web Tokens (JWT) are used for user authentication in the API
- Single binary deploy. All the static assets (frontend JavaScript & CSS files) are embedded into the binary
- Markdown comments
- Avatar upload, including animated GIFs. Auto-generated letter-avatars on user creation
Getting Started
-
Create a new empty database (MySQL оr PostgreSQL) that will be used as a data store and a database user with all privileges granted on this database.
-
Obtain OAuth 2.0 credentials (client_id and secret) from at least one of the providers (Google, Facebook, Github) so users can log into the web application. The OAuth callback url will be
<base_url>/oauth/end/<provider>. The<base_url>is where the sc2lover web app will be mounted on your site and the<provider>is the lowercase provider name. For example, if base_url ishttps://my.website.com/forum/, then the oauth callback url for google will behttps://my.website.com/forum/oauth/end/google. -
Download and compile the sc2lover binary:
$ go get -u github.com/JinAirsOs/sc2lover/cmd/sc2lover -
Inside an empty directory run:
$ sc2lover initThis will generate an initial configuration file "sc2lover.conf" inside the current dir. Edit the configuration file to set the server listen address, the base url, the database and file storage parameters, OAuth credentials, etc.
-
Run the following command to start the sc2lover web server.
$ sc2lover start -
Sign in into your web application using one of the social login providers. Then run the following command to grant admin privileges to your user.
$ sc2lover add-admin <your-username>
Notes
front-end develop
do not forgot
go generate ./static
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides an HTTP handler that handles the bebop REST API requests.
|
Package api provides an HTTP handler that handles the bebop REST API requests. |
|
Package avatar provides a service that manages bebop user avatars.
|
Package avatar provides a service that manages bebop user avatars. |
|
cmd
|
|
|
sc2lover
sc2lover is a simple discussion board / forum web application.
|
sc2lover is a simple discussion board / forum web application. |
|
Package config provides the bebop configuration file structure, initialization and reading.
|
Package config provides the bebop configuration file structure, initialization and reading. |
|
Package filestorage provides a file storage service that manages public web app files e.g.
|
Package filestorage provides a file storage service that manages public web app files e.g. |
|
Package jwt provides a service to create and verify JWT auth tokens for the bebop web app.
|
Package jwt provides a service to create and verify JWT auth tokens for the bebop web app. |
|
Package oauth provides an HTTP handler to handle OAuth2 redirect and callback requests for the bebop web app.
|
Package oauth provides an HTTP handler to handle OAuth2 redirect and callback requests for the bebop web app. |
|
Package static provides http handlers for serving static files from the embedded filesystem or from a local directory.
|
Package static provides http handlers for serving static files from the embedded filesystem or from a local directory. |
|
Package store provides a bebop data store interface.
|
Package store provides a bebop data store interface. |
|
mysql
Package mysql provides a MySQL implementation of the bebop data store interface.
|
Package mysql provides a MySQL implementation of the bebop data store interface. |
|
postgresql
Package postgresql provides a PostgreSQL implementation of the bebop data store interface.
|
Package postgresql provides a PostgreSQL implementation of the bebop data store interface. |